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": "4db3c58e-6ba9-4788-a620-ad3970336d78",
"jobs_id": "90d21cf1-2df3-45f7-bec0-bcaf691b7e65",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3ffde721-ab17-434b-b368-420015e9ad4b",
"_parent_id": "cd29fc3b-2700-4856-a015-3b20c7d7ceec",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f0c3d2df-cf8a-4bec-9761-9d1fd6c55875",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2eeb3895-1408-4c3c-8ec6-f7698e8d07c7",
"_parent_id": "02d45c06-b818-40b0-835e-c2faa6e4aba4",
"root_parent_id": "a41e9919-7b52-4b03-b08b-914ff11655c0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "43968f5a-40b7-41b9-8240-9fffa29f2b2b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ced2d57f-9373-44ac-a0bf-987ee7ab3b3d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "37586faa-7d1d-4641-9be2-e40f6dab3dde",
"_parent_code": "sample string 6",
"sales_organization_id": "fcc123a8-9f97-48d7-8f98-7c987d4ac818",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "412ef3a9-cceb-4cb1-ab2c-ea4adaee37af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0952e8bf-1572-4e93-90b9-e1ebf1285e25",
"db_currency_id": "0166b085-1672-4915-8eab-8e6f6e540dc6",
"db_language_id": "315851fa-2678-44cb-ac6f-cfd252fc2f24",
"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-04-02T09:51:36.2242573+00:00"
},
"modified_dateutc": "2026-04-02T09:51:36.2242573+00:00"
},
"equipment_model_id": "da3bd460-0253-452a-b1c9-8f03213cb81e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c0ce09f6-6c7c-4698-b936-8b9a34929f19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "87c08b02-52c7-43e2-8af5-654039d4ebae",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "15d20475-20de-4700-b497-48a015524da2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a4edb4e4-641b-42c4-9895-35a30806ed14",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "412ef3a9-cceb-4cb1-ab2c-ea4adaee37af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0952e8bf-1572-4e93-90b9-e1ebf1285e25",
"db_currency_id": "0166b085-1672-4915-8eab-8e6f6e540dc6",
"db_language_id": "315851fa-2678-44cb-ac6f-cfd252fc2f24",
"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-04-02T09:51:36.2242573+00:00"
},
"modified_dateutc": "2026-04-02T09:51:36.2242573+00:00"
},
"equipment_family_id": "faca1fd2-2a74-44bd-8b5d-a583d2eee755",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ced2d57f-9373-44ac-a0bf-987ee7ab3b3d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "37586faa-7d1d-4641-9be2-e40f6dab3dde",
"_parent_code": "sample string 6",
"sales_organization_id": "fcc123a8-9f97-48d7-8f98-7c987d4ac818",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "412ef3a9-cceb-4cb1-ab2c-ea4adaee37af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0952e8bf-1572-4e93-90b9-e1ebf1285e25",
"db_currency_id": "0166b085-1672-4915-8eab-8e6f6e540dc6",
"db_language_id": "315851fa-2678-44cb-ac6f-cfd252fc2f24",
"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-04-02T09:51:36.2242573+00:00"
},
"modified_dateutc": "2026-04-02T09:51:36.2242573+00:00"
},
"date_in_production_since": "2026-04-02T09:51:36.2242573+00:00",
"date_out_of_production_since": "2026-04-02T09:51:36.2242573+00:00",
"date_end_support": "2026-04-02T09:51:36.2242573+00:00",
"sales_organization_id": "73f80ac8-7258-4348-8d49-c149b0e98b1b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "412ef3a9-cceb-4cb1-ab2c-ea4adaee37af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0952e8bf-1572-4e93-90b9-e1ebf1285e25",
"db_currency_id": "0166b085-1672-4915-8eab-8e6f6e540dc6",
"db_language_id": "315851fa-2678-44cb-ac6f-cfd252fc2f24",
"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-04-02T09:51:36.2242573+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-04-02T09:51:36.2242573+00:00"
},
"project_status_id": "f03b45a7-9984-4076-ae49-b1d79cbbf477",
"project_status_code": "sample string 10",
"project_status": {
"id": "226ef4c0-5f56-4b4c-bbf4-42be59a728ed",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e8c065a7-1691-4bde-8cf8-0a33e614659e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "412ef3a9-cceb-4cb1-ab2c-ea4adaee37af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0952e8bf-1572-4e93-90b9-e1ebf1285e25",
"db_currency_id": "0166b085-1672-4915-8eab-8e6f6e540dc6",
"db_language_id": "315851fa-2678-44cb-ac6f-cfd252fc2f24",
"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-04-02T09:51:36.2242573+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-02T09:51:36.2242573+00:00"
},
"company_id": "7307f704-0713-42b3-878e-f5b9fc57b7b0",
"company_code": "sample string 12",
"db_address_id": "3ad41328-8da9-4be0-bfe1-15fb2c8d3a86",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "46bf2d65-cced-4129-ad1f-45857f588784",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "53a00873-7c8b-4acc-b108-0620671e669e",
"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-04-02T09:51:36.2242573+00:00",
"date_create": "2026-04-02T09:51:36.2242573+00:00",
"date_update": "2026-04-02T09:51:36.2242573+00:00",
"updated_by_user_id": "1dc22d92-5787-4ad1-9245-619ee6799b76",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-02T09:51:36.2242573+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-04-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-02T09:51:36.2242573+00:00",
"date_last_job": "2026-04-02T09:51:36.2242573+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-02T09:51:36.2242573+00:00",
"modified_dateutc": "2026-04-02T09:51:36.2242573+00:00",
"is_mobile_installation": true
},
"job_type_id": "1c5672dc-568f-4f75-80df-1fa2ed73c2e0",
"job_type_code": "sample string 7",
"job_type": {
"id": "e8c8cb7b-66c5-4744-9127-9cd64b4d6119",
"name": "sample string 2",
"sales_organization_id": "22808aef-ac96-4612-b25f-246e659a7f2f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-02T09:51:36.2242573+00:00",
"code": "sample string 7"
},
"job_priority_id": "4d1f248a-7364-4243-abcf-98536ef71301",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "31d3eada-fecc-4818-9bc7-4ddc2600a787",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3470bf9e-d9e8-4781-b48d-f2f5f75d1d42",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "412ef3a9-cceb-4cb1-ab2c-ea4adaee37af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0952e8bf-1572-4e93-90b9-e1ebf1285e25",
"db_currency_id": "0166b085-1672-4915-8eab-8e6f6e540dc6",
"db_language_id": "315851fa-2678-44cb-ac6f-cfd252fc2f24",
"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-04-02T09:51:36.2242573+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-02T09:51:36.2242573+00:00"
},
"job_status_id": "2ce74750-6ad5-4225-bb97-2a234ee87409",
"job_status_code": "sample string 11",
"db_address_id": "350aa29b-882c-4780-9368-ffa47b03049c",
"contact_id": "2d5864c4-dc7e-4641-a2cb-04bb4e70ba18",
"requested_by_company_id": "48580c0f-bb39-4097-8224-d93ea5dcaaca",
"requested_by_contact_id": "489c37a3-9f9c-475f-aa94-aba0195dc7ac",
"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-04-02T09:51:36.2242573+00:00",
"due_date": "2026-04-02T09:51:36.2242573+00:00",
"date_create": "2026-04-02T09:51:36.2242573+00:00",
"date_update": "2026-04-02T09:51:36.2242573+00:00",
"date_closed": "2026-04-02T09:51:36.2242573+00:00",
"suggested_user_id": "e3b91b51-c5fb-4169-8053-c0d2051fe9b2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ac8409b5-43d0-4a92-91a6-81425721c468",
"db_language_id": "d0963937-e0be-4c6a-85be-1c8d615326e1",
"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-04-02T09:51:36.2242573+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c38ad2b1-b7c3-4b6d-bbb1-09117bdeee6a",
"sales_organization": {
"id": "412ef3a9-cceb-4cb1-ab2c-ea4adaee37af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0952e8bf-1572-4e93-90b9-e1ebf1285e25",
"db_currency_id": "0166b085-1672-4915-8eab-8e6f6e540dc6",
"db_language_id": "315851fa-2678-44cb-ac6f-cfd252fc2f24",
"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-04-02T09:51:36.2242573+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3b08e642-c5b5-4a3e-bf31-f31bb6595414",
"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": "7d552b74-61db-4a0e-8278-24a63c9e9ec6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-02T09:51:36.2242573+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b94db4b2-ca88-4c27-a4d1-d3fc30579713"
},
"suggested_date_start": "2026-04-02T09:51:36.2242573+00:00",
"skill_id": "e49c05c8-d912-468a-80c0-cd9f52326a69",
"skill_code": "sample string 32",
"skill": {
"id": "b4e1ef9e-a355-4189-9847-0df66d9a120d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "815856db-ceeb-4b36-ab63-91461dbf6a91",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "412ef3a9-cceb-4cb1-ab2c-ea4adaee37af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0952e8bf-1572-4e93-90b9-e1ebf1285e25",
"db_currency_id": "0166b085-1672-4915-8eab-8e6f6e540dc6",
"db_language_id": "315851fa-2678-44cb-ac6f-cfd252fc2f24",
"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-04-02T09:51:36.2242573+00:00"
},
"modified_dateutc": "2026-04-02T09:51:36.2242573+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1cd9a7c7-febf-42c0-ae86-688cb065d153",
"date_reported_by_company": "2026-04-02T09:51:36.2242573+00:00",
"id2": 36,
"company_id": "515e909b-2d81-45ce-a8b7-aa15a43bedda",
"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": "1563aada-cb5d-4cf0-8aef-93c37868195c",
"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-04-02T09:51:36.2242573+00:00"
},
"work_instruction_details_id": "a165147a-e862-426e-921f-f147ec5f2011",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2dcf03b9-b25f-4494-9c12-f38f8d1f0ea6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1f2242f6-582c-4543-99a6-dfff55052e3f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-02T09:51:36.2242573+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": "82756d19-c8d8-4d96-9f75-b20635b7b647",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-02T09:51:36.2242573+00:00"
}