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": "a8ebc4bd-8af8-452b-a3a4-af50fc05f3ba",
"jobs_id": "fde65a92-b0cb-45c3-b37c-bf4e4c4ed5df",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "378c448e-5a45-4cd2-abc5-173a7dc4e9bd",
"_parent_id": "937243d2-cc36-41bc-b271-3f808a019438",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c1a7967c-fe16-4127-a261-d0a0f6a423bc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "18d3d219-419a-4170-be0e-5c4a18517e7e",
"_parent_id": "00860ade-fe98-433a-852a-0a44af8b368c",
"root_parent_id": "871f85a0-514a-424e-9ed1-aad096f580ee",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8798c414-74c3-4588-aa27-a3867991ce63",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2b62077b-b7b5-427a-884d-8dbbd938694e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6196ff58-c3c9-4201-8dd7-bdbe74f1b04b",
"_parent_code": "sample string 6",
"sales_organization_id": "fc0ee818-7cc7-443f-a35c-eb91164f57b7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a0f56f73-faf6-43c9-bfdd-8d0f56482a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d9c8a7b7-4850-449c-aa08-10163720bc2a",
"db_currency_id": "3b277081-2004-4fe1-8b97-e6124380c92a",
"db_language_id": "22a89f1d-fc34-4c1d-9340-f60da8507270",
"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-29T10:28:00.7924205+00:00"
},
"modified_dateutc": "2026-10-29T10:28:00.7924205+00:00"
},
"equipment_model_id": "311eb6ae-379e-471c-9f28-434362887535",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7700017f-2b98-4ad5-ad87-fc295e737d70",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b4c08547-6ac2-4870-8d03-f6ad58c05493",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "29b45aa3-4dff-4047-8f38-914fb9d5647a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c383e994-31aa-40e1-af06-43e9d45467eb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a0f56f73-faf6-43c9-bfdd-8d0f56482a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d9c8a7b7-4850-449c-aa08-10163720bc2a",
"db_currency_id": "3b277081-2004-4fe1-8b97-e6124380c92a",
"db_language_id": "22a89f1d-fc34-4c1d-9340-f60da8507270",
"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-29T10:28:00.7924205+00:00"
},
"modified_dateutc": "2026-10-29T10:28:00.7924205+00:00"
},
"equipment_family_id": "f61cf703-c726-45a6-aff2-b69fcbbeeeb7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2b62077b-b7b5-427a-884d-8dbbd938694e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6196ff58-c3c9-4201-8dd7-bdbe74f1b04b",
"_parent_code": "sample string 6",
"sales_organization_id": "fc0ee818-7cc7-443f-a35c-eb91164f57b7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a0f56f73-faf6-43c9-bfdd-8d0f56482a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d9c8a7b7-4850-449c-aa08-10163720bc2a",
"db_currency_id": "3b277081-2004-4fe1-8b97-e6124380c92a",
"db_language_id": "22a89f1d-fc34-4c1d-9340-f60da8507270",
"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-29T10:28:00.7924205+00:00"
},
"modified_dateutc": "2026-10-29T10:28:00.7924205+00:00"
},
"date_in_production_since": "2026-10-29T10:28:00.7924205+00:00",
"date_out_of_production_since": "2026-10-29T10:28:00.7924205+00:00",
"date_end_support": "2026-10-29T10:28:00.7924205+00:00",
"sales_organization_id": "3c14c908-1fcd-4f22-8e19-eaa08cb28e8a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a0f56f73-faf6-43c9-bfdd-8d0f56482a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d9c8a7b7-4850-449c-aa08-10163720bc2a",
"db_currency_id": "3b277081-2004-4fe1-8b97-e6124380c92a",
"db_language_id": "22a89f1d-fc34-4c1d-9340-f60da8507270",
"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-29T10:28:00.7924205+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-29T10:28:00.7924205+00:00"
},
"project_status_id": "5e3014c4-d556-45a4-9ccd-a4467edb1d9b",
"project_status_code": "sample string 10",
"project_status": {
"id": "af1d237c-6096-48ae-8ea9-13690305a3eb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "379adf5b-e1d5-434e-a89a-0ad346029ec6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a0f56f73-faf6-43c9-bfdd-8d0f56482a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d9c8a7b7-4850-449c-aa08-10163720bc2a",
"db_currency_id": "3b277081-2004-4fe1-8b97-e6124380c92a",
"db_language_id": "22a89f1d-fc34-4c1d-9340-f60da8507270",
"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-29T10:28:00.7924205+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-29T10:28:00.7924205+00:00"
},
"company_id": "c59fb4a2-4b14-4ca9-a7e5-a1d2c6b1841e",
"company_code": "sample string 12",
"db_address_id": "e7b43232-6625-4bb1-9a9a-f3db62bf188d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "199612a3-8d0d-41c9-a6ce-30919830c98b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e0a0621d-2453-4edb-b638-cf0949fed7dd",
"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-29T10:28:00.7924205+00:00",
"date_create": "2026-10-29T10:28:00.7924205+00:00",
"date_update": "2026-10-29T10:28:00.7924205+00:00",
"updated_by_user_id": "c04fc7aa-5e55-4f67-88e6-56236b70bfab",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-29T10:28:00.7924205+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-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-29T10:28:00.7924205+00:00",
"date_last_job": "2026-10-29T10:28:00.7924205+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-29T10:28:00.7924205+00:00",
"modified_dateutc": "2026-10-29T10:28:00.7924205+00:00",
"is_mobile_installation": true
},
"job_type_id": "0ae80feb-e8b6-43eb-8306-1721d2262472",
"job_type_code": "sample string 7",
"job_type": {
"id": "b40007bf-c48b-45cd-9c76-47559f32147e",
"name": "sample string 2",
"sales_organization_id": "227d8eb6-7243-4cea-80c4-1d10edf909ce",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-29T10:28:00.7924205+00:00",
"code": "sample string 7"
},
"job_priority_id": "7355fc3f-14a1-4808-b77d-149a5e44141d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "422e4ae9-837f-4661-a4be-21ebe6938011",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f8828fc1-ac35-4a49-a77c-72cc5f171bf4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a0f56f73-faf6-43c9-bfdd-8d0f56482a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d9c8a7b7-4850-449c-aa08-10163720bc2a",
"db_currency_id": "3b277081-2004-4fe1-8b97-e6124380c92a",
"db_language_id": "22a89f1d-fc34-4c1d-9340-f60da8507270",
"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-29T10:28:00.7924205+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-29T10:28:00.7924205+00:00"
},
"job_status_id": "ac4a4771-457f-4859-a497-55939dfe4537",
"job_status_code": "sample string 11",
"db_address_id": "2a32efec-c674-40e5-8de6-3f3cb99b339f",
"contact_id": "66407734-5809-4903-b58f-0ddaecec3b74",
"requested_by_company_id": "7c7cc60c-d812-46c3-b479-9ff52a8b9894",
"requested_by_contact_id": "dedbeb1c-b641-4e64-9a66-046ec89e78f3",
"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-29T10:28:00.7924205+00:00",
"due_date": "2026-10-29T10:28:00.7924205+00:00",
"date_create": "2026-10-29T10:28:00.7924205+00:00",
"date_update": "2026-10-29T10:28:00.7924205+00:00",
"date_closed": "2026-10-29T10:28:00.7924205+00:00",
"suggested_user_id": "ad0144ed-d1b0-4993-bea3-d59c5e6c949a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3c52dda4-9494-44ae-bb3e-cbb411902abe",
"db_language_id": "e4dbdd4d-7207-4a79-a864-b5f4b4946232",
"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-29T10:28:00.7924205+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "408b21a0-0b3b-4997-b63d-34be5208a396",
"sales_organization": {
"id": "a0f56f73-faf6-43c9-bfdd-8d0f56482a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d9c8a7b7-4850-449c-aa08-10163720bc2a",
"db_currency_id": "3b277081-2004-4fe1-8b97-e6124380c92a",
"db_language_id": "22a89f1d-fc34-4c1d-9340-f60da8507270",
"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-29T10:28:00.7924205+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c8b2f4ee-06d4-495f-ac48-8df7920baa78",
"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": "e4dfd8a3-49cf-4d89-9875-536b378bbba7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-29T10:28:00.7924205+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8f2601be-07e8-47ca-b6e6-69eb488af930"
},
"suggested_date_start": "2026-10-29T10:28:00.7924205+00:00",
"skill_id": "e0614107-823d-4cfe-b4ba-7c8185cb8537",
"skill_code": "sample string 32",
"skill": {
"id": "2dbcabbd-e829-42ab-84bd-370a5f50810f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a73a49f8-e97c-4e39-9e80-dcb7c1d84772",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a0f56f73-faf6-43c9-bfdd-8d0f56482a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d9c8a7b7-4850-449c-aa08-10163720bc2a",
"db_currency_id": "3b277081-2004-4fe1-8b97-e6124380c92a",
"db_language_id": "22a89f1d-fc34-4c1d-9340-f60da8507270",
"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-29T10:28:00.7924205+00:00"
},
"modified_dateutc": "2026-10-29T10:28:00.7924205+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "458da6e1-d53c-4067-9147-08d69219bc4c",
"date_reported_by_company": "2026-10-29T10:28:00.7924205+00:00",
"id2": 36,
"company_id": "02c685c4-b653-4beb-a8e2-934f13129c19",
"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": "54ce7806-cf3c-4ce5-8301-67821515cf36",
"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-29T10:28:00.7924205+00:00"
},
"work_instruction_details_id": "c57a2daf-7486-4e03-84d9-f0966c972249",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8505bfc8-12ea-4417-bd03-97d3f0dd6aa6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c3cf951b-8595-46b8-997c-4a2fdd896405",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-29T10:28:00.7924205+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": "ac8cd540-7cc9-4355-9817-e6fa75ebc93d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-29T10:28:00.7924205+00:00"
}