Retrieves the job work instruction list with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "85ea20d6-5b85-4823-a8cd-969ca2e89b0a",
"jobs_id": "23967d82-d4df-44f3-94d0-1e4a5f6d2b60",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e9a7f600-b72e-45ec-a73d-8ea711f04eb9",
"_parent_id": "5d8ad5b2-ae4d-49d2-9ff3-d4e39377950a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1cea601f-c94b-40a5-ade2-b1d2830545ef",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5def37ce-32b0-4ea7-9409-af0204e02d25",
"_parent_id": "22c9868d-ba1a-45a0-baa2-f3d817029bae",
"root_parent_id": "cb03bf95-2154-4c73-bb3f-84c6ea4633b4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fb5e0532-0893-4a5d-93dd-510297f6e2ad",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "31e9d18a-2704-4c66-906d-1ac350b0c477",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e1c9453c-bc94-45d5-b6ac-c3c70faff42e",
"_parent_code": "sample string 6",
"sales_organization_id": "b6d2de86-9084-4ed0-a980-6ae47ba873ae",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3c45462b-3e1f-4c75-b8fb-ff7194b2e875",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "adbe42dd-26b0-42a5-900f-e69c1be24f67",
"db_currency_id": "5fe33b48-ee81-4a1a-8554-c06078ea3df1",
"db_language_id": "e1463b24-c1c1-409c-80b9-3c7429d074c9",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00"
},
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00"
},
"equipment_model_id": "f4780429-8d59-4494-a168-d633bf2c240e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4a9faca4-f62e-4d06-ac4d-10c41f35eb74",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "28383775-dffd-42ef-bb9c-4ee1689d7fbd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1713acbb-6170-462f-b6bf-6fc916764f40",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c4eaebb0-336c-47d6-8a81-acd96da5c020",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3c45462b-3e1f-4c75-b8fb-ff7194b2e875",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "adbe42dd-26b0-42a5-900f-e69c1be24f67",
"db_currency_id": "5fe33b48-ee81-4a1a-8554-c06078ea3df1",
"db_language_id": "e1463b24-c1c1-409c-80b9-3c7429d074c9",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00"
},
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00"
},
"equipment_family_id": "a1bcfdba-b6d9-4298-9773-bbde4ffc1451",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "31e9d18a-2704-4c66-906d-1ac350b0c477",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e1c9453c-bc94-45d5-b6ac-c3c70faff42e",
"_parent_code": "sample string 6",
"sales_organization_id": "b6d2de86-9084-4ed0-a980-6ae47ba873ae",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3c45462b-3e1f-4c75-b8fb-ff7194b2e875",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "adbe42dd-26b0-42a5-900f-e69c1be24f67",
"db_currency_id": "5fe33b48-ee81-4a1a-8554-c06078ea3df1",
"db_language_id": "e1463b24-c1c1-409c-80b9-3c7429d074c9",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00"
},
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00"
},
"date_in_production_since": "2026-10-06T11:42:08.6224086+00:00",
"date_out_of_production_since": "2026-10-06T11:42:08.6224086+00:00",
"date_end_support": "2026-10-06T11:42:08.6224086+00:00",
"sales_organization_id": "10a851ec-1fdd-4e92-bc97-10144ebb47a5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3c45462b-3e1f-4c75-b8fb-ff7194b2e875",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "adbe42dd-26b0-42a5-900f-e69c1be24f67",
"db_currency_id": "5fe33b48-ee81-4a1a-8554-c06078ea3df1",
"db_language_id": "e1463b24-c1c1-409c-80b9-3c7429d074c9",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00"
},
"project_status_id": "788b44c3-46ba-4c05-900a-18aea6f386e7",
"project_status_code": "sample string 10",
"project_status": {
"id": "f31f8e1e-3ad9-4b7a-b3b4-85ebb92eaa6c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1d4f942a-6fcb-492b-a409-0b181f0eede2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c45462b-3e1f-4c75-b8fb-ff7194b2e875",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "adbe42dd-26b0-42a5-900f-e69c1be24f67",
"db_currency_id": "5fe33b48-ee81-4a1a-8554-c06078ea3df1",
"db_language_id": "e1463b24-c1c1-409c-80b9-3c7429d074c9",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00"
},
"company_id": "6a0005e7-7206-4904-b02e-b29e11fecaca",
"company_code": "sample string 12",
"db_address_id": "b2b5d774-999f-430b-a1e9-1ba43eb6c405",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e078b0cf-3f1c-4ef2-b674-bea16d8eafe1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2b49deac-dfc3-43af-92a2-6435c1143a2d",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2026-10-06T11:42:08.6224086+00:00",
"date_create": "2026-10-06T11:42:08.6224086+00:00",
"date_update": "2026-10-06T11:42:08.6224086+00:00",
"updated_by_user_id": "c0eb3547-2be2-4ede-9c2c-db8f7e3539ae",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-06T11:42:08.6224086+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2026-10-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-06T11:42:08.6224086+00:00",
"date_last_job": "2026-10-06T11:42:08.6224086+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-06T11:42:08.6224086+00:00",
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00",
"is_mobile_installation": true
},
"job_type_id": "2bb0c6c7-4e83-4010-a173-7d15e943beb5",
"job_type_code": "sample string 7",
"job_type": {
"id": "4503ebbf-d662-4a1f-b63e-08056f2e218f",
"name": "sample string 2",
"sales_organization_id": "dfa9c234-c3bb-419a-9ef4-d8b142ef87c5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00",
"code": "sample string 7"
},
"job_priority_id": "680311a6-fff7-4648-b992-f7b8365b0507",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "680d6a4e-911d-44ab-9146-062e5fa0b852",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "79977fd7-d43c-49ce-a19d-0e86567ba07e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c45462b-3e1f-4c75-b8fb-ff7194b2e875",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "adbe42dd-26b0-42a5-900f-e69c1be24f67",
"db_currency_id": "5fe33b48-ee81-4a1a-8554-c06078ea3df1",
"db_language_id": "e1463b24-c1c1-409c-80b9-3c7429d074c9",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00"
},
"job_status_id": "d2a7f021-0994-443e-9a44-a75818071704",
"job_status_code": "sample string 11",
"db_address_id": "a0336a0c-f2d9-4fb1-bae2-e6e67eecb380",
"contact_id": "709a484c-52f5-46cb-a1a8-e9cdbe97bcba",
"requested_by_company_id": "44555e81-24fb-44b1-ad42-f0edcd500f66",
"requested_by_contact_id": "4c344915-b229-46fb-94f1-0c45643633ca",
"reference_back_office": "sample string 16",
"name": "sample string 17",
"description": "sample string 18",
"working_sequence": 19,
"internal_memo": "sample string 20",
"prejob_information": "sample string 21",
"estimated_time": 22,
"earliest_date_plannable": "2026-10-06T11:42:08.6423725+00:00",
"due_date": "2026-10-06T11:42:08.6423725+00:00",
"date_create": "2026-10-06T11:42:08.6423725+00:00",
"date_update": "2026-10-06T11:42:08.6423725+00:00",
"date_closed": "2026-10-06T11:42:08.6423725+00:00",
"suggested_user_id": "130fcfe5-7566-4db9-a16f-ce260b27c78a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5d0ca080-345b-4215-be0c-0a5e83a987e4",
"db_language_id": "5feecbe9-1f01-4b2b-92ed-005be07ac1ae",
"username": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"code": "sample string 6",
"archived": true,
"disabled": true,
"emergency_contact": "sample string 9",
"bankaccount": "sample string 10",
"social_security": "sample string 11",
"place_of_birth": "sample string 12",
"nationality": "sample string 13",
"functions": "sample string 14",
"birthdate": "2026-10-06T11:42:08.6423725+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a23358c3-4535-42d9-8c34-9956c1cdc402",
"sales_organization": {
"id": "3c45462b-3e1f-4c75-b8fb-ff7194b2e875",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "adbe42dd-26b0-42a5-900f-e69c1be24f67",
"db_currency_id": "5fe33b48-ee81-4a1a-8554-c06078ea3df1",
"db_language_id": "e1463b24-c1c1-409c-80b9-3c7429d074c9",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "dcdd1386-830f-4748-a5f6-40fb7345c70b",
"email": "sample string 22",
"phone": "sample string 23",
"fax": "sample string 24",
"mobile": "sample string 25",
"private_email": "sample string 26",
"private_phone": "sample string 27",
"private_fax": "sample string 28",
"private_mobile": "sample string 29",
"private_street": "sample string 30",
"private_street_number": "sample string 31",
"private_city": "sample string 32",
"private_zip": "sample string 33",
"private_db_country_id": "ac1636e5-fccc-469e-ba3f-79302d309085",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-06T11:42:08.6423725+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b3face52-b947-4c9b-94fe-ba58bea07ccf"
},
"suggested_date_start": "2026-10-06T11:42:08.6423725+00:00",
"skill_id": "5ee245cf-7c34-45c2-8b77-1daafbe2f252",
"skill_code": "sample string 32",
"skill": {
"id": "60672d90-66da-4598-bb6a-f6917772a637",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9bf18ddd-bc8f-4ca6-aa55-31a56cfc606c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c45462b-3e1f-4c75-b8fb-ff7194b2e875",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "adbe42dd-26b0-42a5-900f-e69c1be24f67",
"db_currency_id": "5fe33b48-ee81-4a1a-8554-c06078ea3df1",
"db_language_id": "e1463b24-c1c1-409c-80b9-3c7429d074c9",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-10-06T11:42:08.6224086+00:00"
},
"modified_dateutc": "2026-10-06T11:42:08.6423725+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "61b28ed5-3c7e-4c53-87fa-a58974b67b6a",
"date_reported_by_company": "2026-10-06T11:42:08.6423725+00:00",
"id2": 36,
"company_id": "fe976127-ac1c-45fa-8c14-ea2f9756d685",
"company_code": "sample string 38",
"db_address_name": "sample string 39",
"db_address_street": "sample string 40",
"db_address_street2": "sample string 41",
"db_address_street_number": "sample string 42",
"db_address_city": "sample string 43",
"db_address_zip": "sample string 44",
"db_address_db_country_id": "9db100f0-41f3-472e-bc6c-9cf2dd20e6df",
"db_address_db_country_code": "sample string 46",
"db_address_phone": "sample string 47",
"db_address_email": "sample string 48",
"db_address_latitude_decimal": 49.0,
"db_address_longitude_decimal": 50.0,
"estimated_quantity_remark": "sample string 51",
"modified_dateutc": "2026-10-06T11:42:08.6532002+00:00"
},
"work_instruction_details_id": "a3f67ddc-be5f-4e75-900e-3fd005f34393",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c73ff9a6-598d-48b3-b6cd-954d421888ea",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "be8517fd-94e5-4381-81e9-b7e224c2c659",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-06T11:42:08.6532002+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "c18cda8c-e59c-4bd4-aa86-9007bc192745",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-06T11:42:08.6532002+00:00"
}