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": "690caaff-075c-4a0e-8d7b-08ffb7ce156e",
"jobs_id": "5f6d8fef-3bd1-4dcd-8c74-0a2a822915f2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "53befff3-d2ef-40a0-8fae-ce06a9cc5ba1",
"_parent_id": "84670e30-341a-40fb-a019-5941a6f09d2c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "90d99236-930a-4893-b607-87480394b064",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9e87d8c7-63ff-49cb-8fda-b200ef23ceba",
"_parent_id": "827252e8-9f1a-47f9-8213-7f5e6d42b1ef",
"root_parent_id": "b3fd84b8-ad25-4111-83cb-0da56c60cbda",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "49c0b3d8-021a-4306-8c4f-96a01b12c83a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c851ab83-390b-4ca2-b296-c301f13d4431",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e65c8355-2fcb-4b8a-a194-64982d7bdd50",
"_parent_code": "sample string 6",
"sales_organization_id": "7c6f1c6a-e4fe-4e78-aaa6-0ae4dca0be4b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0071b50b-6945-4039-b1ee-7372eeb9e78e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36d1e11-2819-458a-88dc-07051157296c",
"db_currency_id": "523ded4b-a7c2-499e-9166-f0aa1330e24e",
"db_language_id": "1ae68a74-48a8-455c-b23b-992fb041750b",
"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-09-14T16:43:49.1124943+00:00"
},
"modified_dateutc": "2026-09-14T16:43:49.1124943+00:00"
},
"equipment_model_id": "cbd407ab-4583-4e72-b671-84a56b8ddf59",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ff5a534c-1963-4534-b4b2-34cf05638995",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1a87a447-027b-4ecb-b54a-a7fd82e2ee03",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f29935e9-28f6-4d04-9dc7-87662f69811e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3d176f22-06f4-4427-812c-93d7fc9173a9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0071b50b-6945-4039-b1ee-7372eeb9e78e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36d1e11-2819-458a-88dc-07051157296c",
"db_currency_id": "523ded4b-a7c2-499e-9166-f0aa1330e24e",
"db_language_id": "1ae68a74-48a8-455c-b23b-992fb041750b",
"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-09-14T16:43:49.1124943+00:00"
},
"modified_dateutc": "2026-09-14T16:43:49.1124943+00:00"
},
"equipment_family_id": "b9b47798-6342-43e3-82b3-2dcf2a031803",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c851ab83-390b-4ca2-b296-c301f13d4431",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e65c8355-2fcb-4b8a-a194-64982d7bdd50",
"_parent_code": "sample string 6",
"sales_organization_id": "7c6f1c6a-e4fe-4e78-aaa6-0ae4dca0be4b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0071b50b-6945-4039-b1ee-7372eeb9e78e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36d1e11-2819-458a-88dc-07051157296c",
"db_currency_id": "523ded4b-a7c2-499e-9166-f0aa1330e24e",
"db_language_id": "1ae68a74-48a8-455c-b23b-992fb041750b",
"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-09-14T16:43:49.1124943+00:00"
},
"modified_dateutc": "2026-09-14T16:43:49.1124943+00:00"
},
"date_in_production_since": "2026-09-14T16:43:49.1124943+00:00",
"date_out_of_production_since": "2026-09-14T16:43:49.1124943+00:00",
"date_end_support": "2026-09-14T16:43:49.1124943+00:00",
"sales_organization_id": "11d32888-780f-4e7a-985e-848b8c76e8c3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0071b50b-6945-4039-b1ee-7372eeb9e78e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36d1e11-2819-458a-88dc-07051157296c",
"db_currency_id": "523ded4b-a7c2-499e-9166-f0aa1330e24e",
"db_language_id": "1ae68a74-48a8-455c-b23b-992fb041750b",
"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-09-14T16:43:49.1124943+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-09-14T16:43:49.1124943+00:00"
},
"project_status_id": "88a4735a-d046-4cb9-8589-a8da799b9628",
"project_status_code": "sample string 10",
"project_status": {
"id": "bf93d5e4-9b88-4ab6-891e-7d12e6f27703",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b9815471-c28b-4f97-98c0-4deb60ef2557",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0071b50b-6945-4039-b1ee-7372eeb9e78e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36d1e11-2819-458a-88dc-07051157296c",
"db_currency_id": "523ded4b-a7c2-499e-9166-f0aa1330e24e",
"db_language_id": "1ae68a74-48a8-455c-b23b-992fb041750b",
"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-09-14T16:43:49.1124943+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-14T16:43:49.1124943+00:00"
},
"company_id": "4e12ae88-f1f1-4471-9c3e-af9bb35d03ef",
"company_code": "sample string 12",
"db_address_id": "becb4bbd-22c8-4ee3-ab33-fa382ef6ec74",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fbb07ac7-dde1-4f0e-86b9-3a1433254489",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6d87e65e-0c20-4b34-826a-b4b3a164a051",
"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-09-14T16:43:49.1124943+00:00",
"date_create": "2026-09-14T16:43:49.1124943+00:00",
"date_update": "2026-09-14T16:43:49.1124943+00:00",
"updated_by_user_id": "a83e7cbf-62c9-4ee5-819f-d5f35d5204ad",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-14T16:43:49.1124943+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-09-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-14T16:43:49.1124943+00:00",
"date_last_job": "2026-09-14T16:43:49.1124943+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-14T16:43:49.1124943+00:00",
"modified_dateutc": "2026-09-14T16:43:49.1124943+00:00",
"is_mobile_installation": true
},
"job_type_id": "a86eedf6-6a28-413d-a3be-e40b3b6c4409",
"job_type_code": "sample string 7",
"job_type": {
"id": "35223ca7-a294-4c4d-b33b-d04ca03492d2",
"name": "sample string 2",
"sales_organization_id": "341101e1-bcfa-43ca-a32f-78383767664f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-14T16:43:49.1124943+00:00",
"code": "sample string 7"
},
"job_priority_id": "08bad1de-2f88-4db3-8c1c-cb4a87a07192",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d245dea4-8932-443e-bc95-0e0ab0b211e1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "15df8002-26f1-4b5d-8f29-7ce71ad09bd2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0071b50b-6945-4039-b1ee-7372eeb9e78e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36d1e11-2819-458a-88dc-07051157296c",
"db_currency_id": "523ded4b-a7c2-499e-9166-f0aa1330e24e",
"db_language_id": "1ae68a74-48a8-455c-b23b-992fb041750b",
"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-09-14T16:43:49.1124943+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-14T16:43:49.1124943+00:00"
},
"job_status_id": "cacee82d-a423-4f9c-83cd-01438ef69f82",
"job_status_code": "sample string 11",
"db_address_id": "35671f85-423a-4adc-ae56-a97780db5566",
"contact_id": "5c8064df-8f1d-4702-9b7c-d1921e517dd6",
"requested_by_company_id": "f02f767b-4244-435f-aac2-3d007342ba3f",
"requested_by_contact_id": "8812b061-08d5-4a75-bcec-d265257aabcb",
"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-09-14T16:43:49.1124943+00:00",
"due_date": "2026-09-14T16:43:49.1124943+00:00",
"date_create": "2026-09-14T16:43:49.1124943+00:00",
"date_update": "2026-09-14T16:43:49.1124943+00:00",
"date_closed": "2026-09-14T16:43:49.1124943+00:00",
"suggested_user_id": "f46b1b33-4070-48c7-be54-91c4417fb834",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b41612b3-f0ce-4a6e-bd5c-1df73d4af351",
"db_language_id": "3bde1f31-53d6-4055-846c-bb820706c711",
"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-09-14T16:43:49.1124943+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0c6f3344-4558-40d4-b85c-336595828e2c",
"sales_organization": {
"id": "0071b50b-6945-4039-b1ee-7372eeb9e78e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36d1e11-2819-458a-88dc-07051157296c",
"db_currency_id": "523ded4b-a7c2-499e-9166-f0aa1330e24e",
"db_language_id": "1ae68a74-48a8-455c-b23b-992fb041750b",
"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-09-14T16:43:49.1124943+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ad598388-975a-40a4-a81a-19e88ce621fd",
"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": "466b423c-c118-4583-b7e0-8ecbaf3e4ba4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-14T16:43:49.1124943+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d3b303a8-c75e-43b8-b5ef-d8bc4c064228"
},
"suggested_date_start": "2026-09-14T16:43:49.1124943+00:00",
"skill_id": "97f1a954-5d69-484f-b750-8c0853120a2b",
"skill_code": "sample string 32",
"skill": {
"id": "6715ac89-a486-47a1-b126-5a14a719f2c2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1816d3e5-31b3-46ac-8bc1-8cd15276e57c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0071b50b-6945-4039-b1ee-7372eeb9e78e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36d1e11-2819-458a-88dc-07051157296c",
"db_currency_id": "523ded4b-a7c2-499e-9166-f0aa1330e24e",
"db_language_id": "1ae68a74-48a8-455c-b23b-992fb041750b",
"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-09-14T16:43:49.1124943+00:00"
},
"modified_dateutc": "2026-09-14T16:43:49.1124943+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c52d4e5d-fe98-408f-9a48-97f7af75495e",
"date_reported_by_company": "2026-09-14T16:43:49.1124943+00:00",
"id2": 36,
"company_id": "e59c16af-788d-44da-891c-e1f9244bbd27",
"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": "aaa5deb9-25e8-4f3b-8a10-81c6f51f6b87",
"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-09-14T16:43:49.1124943+00:00"
},
"work_instruction_details_id": "2dc48d08-4300-46af-9fd4-3f2c07955f02",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a7b126c3-0405-4f5d-984b-5e4916b28529",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e897a4da-7381-4279-82ad-624e3d435617",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-14T16:43:49.1124943+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": "32f81530-f39d-46f4-b6f5-069e909509d9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-14T16:43:49.1124943+00:00"
}