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": "92d42583-40e4-4ec2-80f6-970a148e208f",
"jobs_id": "08dc08fa-28df-43ec-8c14-62e00d968230",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8dbe1c35-3609-4e14-bbd0-129884539577",
"_parent_id": "8cbd70bb-458e-48e4-9c4a-d364f4dba0de",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e397c8e7-1ffa-489e-b6ca-87b690cf6403",
"project_reference_back_office": "sample string 5",
"project": {
"id": "742d7c48-873d-4486-808e-f943f0ebdacb",
"_parent_id": "a54319d6-cc7b-4495-809b-289d647b4585",
"root_parent_id": "18c4466d-70b6-4383-8a42-25900ed1a633",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b27ceca3-df4a-4081-8fcb-68c82b8612b4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "06e1bab5-7e2a-4040-a55f-16397abdd30a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "eeb845fd-8f2b-487c-9c5b-67e632cb9aed",
"_parent_code": "sample string 6",
"sales_organization_id": "a3a4d044-9d99-4679-ac1f-dde5fe5cef22",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f5c6f08-3285-4a03-a4ad-9ed922854730",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d27a31e0-483c-46f2-8d02-6435819fe96d",
"db_currency_id": "89876c37-946d-4e83-ab0d-5e4f28400fe2",
"db_language_id": "40751d7e-bf71-4c11-9246-d86c706c1d6a",
"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-05-29T19:48:48.0173062+00:00"
},
"modified_dateutc": "2026-05-29T19:48:48.0173062+00:00"
},
"equipment_model_id": "95fca280-f39b-405b-a445-e69686125881",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "538e19bf-a027-4ba4-9a64-7aabcf024907",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4d36b045-4219-431a-8cc0-9158c249e2c7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "64be466b-4faf-48b1-91a3-0e4dde32f6d5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4a3f778e-e800-4b36-ab83-bc7ff0216a73",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4f5c6f08-3285-4a03-a4ad-9ed922854730",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d27a31e0-483c-46f2-8d02-6435819fe96d",
"db_currency_id": "89876c37-946d-4e83-ab0d-5e4f28400fe2",
"db_language_id": "40751d7e-bf71-4c11-9246-d86c706c1d6a",
"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-05-29T19:48:48.0173062+00:00"
},
"modified_dateutc": "2026-05-29T19:48:48.0173062+00:00"
},
"equipment_family_id": "c23f6840-1f70-4165-9a35-23e75994443b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "06e1bab5-7e2a-4040-a55f-16397abdd30a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "eeb845fd-8f2b-487c-9c5b-67e632cb9aed",
"_parent_code": "sample string 6",
"sales_organization_id": "a3a4d044-9d99-4679-ac1f-dde5fe5cef22",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f5c6f08-3285-4a03-a4ad-9ed922854730",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d27a31e0-483c-46f2-8d02-6435819fe96d",
"db_currency_id": "89876c37-946d-4e83-ab0d-5e4f28400fe2",
"db_language_id": "40751d7e-bf71-4c11-9246-d86c706c1d6a",
"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-05-29T19:48:48.0173062+00:00"
},
"modified_dateutc": "2026-05-29T19:48:48.0173062+00:00"
},
"date_in_production_since": "2026-05-29T19:48:48.0173062+00:00",
"date_out_of_production_since": "2026-05-29T19:48:48.0173062+00:00",
"date_end_support": "2026-05-29T19:48:48.0173062+00:00",
"sales_organization_id": "d5382a7d-8a66-4b29-9113-857f8798beac",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4f5c6f08-3285-4a03-a4ad-9ed922854730",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d27a31e0-483c-46f2-8d02-6435819fe96d",
"db_currency_id": "89876c37-946d-4e83-ab0d-5e4f28400fe2",
"db_language_id": "40751d7e-bf71-4c11-9246-d86c706c1d6a",
"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-05-29T19:48:48.0173062+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-05-29T19:48:48.0173062+00:00"
},
"project_status_id": "0554805a-0465-45f5-b431-ff5753d4b784",
"project_status_code": "sample string 10",
"project_status": {
"id": "bd14df54-fcd9-455d-9288-df50e41bc40f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c2f88d78-0ab7-4ad3-9292-686f5ff49d1f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f5c6f08-3285-4a03-a4ad-9ed922854730",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d27a31e0-483c-46f2-8d02-6435819fe96d",
"db_currency_id": "89876c37-946d-4e83-ab0d-5e4f28400fe2",
"db_language_id": "40751d7e-bf71-4c11-9246-d86c706c1d6a",
"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-05-29T19:48:48.0173062+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-29T19:48:48.0173062+00:00"
},
"company_id": "cbdfa009-508e-4303-9eb3-01882161d6c0",
"company_code": "sample string 12",
"db_address_id": "b3524fe1-3e60-4bed-bde5-4e3314a925f9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a9514c21-c5e5-4e32-9de0-0b8459654161",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "991be747-c021-4943-9f17-86be4b019fc2",
"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-05-29T19:48:48.0173062+00:00",
"date_create": "2026-05-29T19:48:48.0173062+00:00",
"date_update": "2026-05-29T19:48:48.0173062+00:00",
"updated_by_user_id": "65d3cac0-6da3-4de5-9bc2-3966f0be0e9a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-29T19:48:48.0173062+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-05-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-29T19:48:48.0173062+00:00",
"date_last_job": "2026-05-29T19:48:48.0173062+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-29T19:48:48.0173062+00:00",
"modified_dateutc": "2026-05-29T19:48:48.0173062+00:00",
"is_mobile_installation": true
},
"job_type_id": "38a5ff38-9154-4171-9e09-8ffb25a964b6",
"job_type_code": "sample string 7",
"job_type": {
"id": "7e903ab8-303e-487c-80f7-0b0b5a718572",
"name": "sample string 2",
"sales_organization_id": "a87375d9-822f-4b4b-85ff-14c8cbc348cb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-29T19:48:48.0173062+00:00",
"code": "sample string 7"
},
"job_priority_id": "d0a565c4-a562-4006-ad61-215a3e6e4826",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3e3ff5f3-3b50-41e7-a2cc-846250546f20",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d83fb032-c8ab-4bb6-bd6f-eb06c7da788c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f5c6f08-3285-4a03-a4ad-9ed922854730",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d27a31e0-483c-46f2-8d02-6435819fe96d",
"db_currency_id": "89876c37-946d-4e83-ab0d-5e4f28400fe2",
"db_language_id": "40751d7e-bf71-4c11-9246-d86c706c1d6a",
"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-05-29T19:48:48.0173062+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-29T19:48:48.0173062+00:00"
},
"job_status_id": "edec7b63-eef1-4228-ae31-7ad37d6eb123",
"job_status_code": "sample string 11",
"db_address_id": "a9ce483e-e6ea-40b4-a0b6-c587af7366a9",
"contact_id": "e0ca5464-109c-442f-9f66-dd8eede4abf8",
"requested_by_company_id": "4ab1dec2-db0e-4cb6-9f59-b56b01060fbe",
"requested_by_contact_id": "f4f3dd97-ca20-4f0a-8fb2-c7b102fbc732",
"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-05-29T19:48:48.0173062+00:00",
"due_date": "2026-05-29T19:48:48.0173062+00:00",
"date_create": "2026-05-29T19:48:48.0173062+00:00",
"date_update": "2026-05-29T19:48:48.0173062+00:00",
"date_closed": "2026-05-29T19:48:48.0173062+00:00",
"suggested_user_id": "e8e4e814-e9d6-4393-8565-74d644439653",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "928eda4f-0160-4dce-9f61-fe8e8c1901d2",
"db_language_id": "68f9dcf4-de3a-451e-b233-f07d356e02b0",
"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-05-29T19:48:48.0173062+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2c66d64e-e7d2-42da-bbeb-c570dfb71132",
"sales_organization": {
"id": "4f5c6f08-3285-4a03-a4ad-9ed922854730",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d27a31e0-483c-46f2-8d02-6435819fe96d",
"db_currency_id": "89876c37-946d-4e83-ab0d-5e4f28400fe2",
"db_language_id": "40751d7e-bf71-4c11-9246-d86c706c1d6a",
"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-05-29T19:48:48.0173062+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "28676560-cfd1-4199-8e5e-dcbc48d12b1c",
"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": "8f38bdc5-48fa-4ad6-b0e9-00a7c8730adb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-29T19:48:48.0173062+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fe926a65-8e80-4c62-8b50-992042545d32"
},
"suggested_date_start": "2026-05-29T19:48:48.0173062+00:00",
"skill_id": "82d2f822-db99-4aec-9d33-8719992fe496",
"skill_code": "sample string 32",
"skill": {
"id": "a5ce2f8b-02f9-4060-be33-c018b6906f10",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "aecfd43c-dc2d-4fbb-871f-461dc6d07b0d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f5c6f08-3285-4a03-a4ad-9ed922854730",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d27a31e0-483c-46f2-8d02-6435819fe96d",
"db_currency_id": "89876c37-946d-4e83-ab0d-5e4f28400fe2",
"db_language_id": "40751d7e-bf71-4c11-9246-d86c706c1d6a",
"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-05-29T19:48:48.0173062+00:00"
},
"modified_dateutc": "2026-05-29T19:48:48.0173062+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "77895626-fa3e-4b1c-ba16-8ab5a5360555",
"date_reported_by_company": "2026-05-29T19:48:48.0173062+00:00",
"id2": 36,
"company_id": "917f288b-6dff-4cbf-b0e0-cb43e43b69c7",
"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": "f7560887-d3db-434b-b86f-c5aa04895123",
"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-05-29T19:48:48.0173062+00:00"
},
"work_instruction_details_id": "c8f290e5-a42b-4435-a6df-9a73b1bbbf5b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2be4cdfc-c1db-491a-9b8e-e737655490d8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "edec0166-eaed-4236-b100-400257ece150",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-29T19:48:48.0173062+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": "3a38ebcd-68a6-4d9d-ba2c-4f76c4b91635",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-29T19:48:48.0173062+00:00"
}