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": "1836eb6d-966d-4780-b035-a5018b0fa754",
"jobs_id": "37e7c65d-c69c-48dd-9029-83b279a7f06b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "45834e2e-1a37-4f48-8af0-f431997d6b4d",
"_parent_id": "535fba30-29a6-4bd3-805b-faaf60e2e58e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "924e3095-98fe-424c-9911-a62e6c173e9f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "62079337-692f-430f-92e3-be01242b87f2",
"_parent_id": "d8b19e96-9c5b-46f9-b28e-15e95c6682be",
"root_parent_id": "4cdb594a-8436-4146-af87-a472fca42436",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a3e623f2-cb05-425e-8d33-39bb12130f23",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3a5703b2-0250-4dd3-b706-9ee6fbd7a069",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1e540001-f442-4afc-95d3-ad41e87ceb8d",
"_parent_code": "sample string 6",
"sales_organization_id": "d0524e38-aa28-44e1-89cc-b3b387a339ff",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e2d5b679-8e7e-44e8-9ca1-a8f5e54a751b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04ba40a6-91f3-421f-a1db-fee3af835569",
"db_currency_id": "f61ba35e-496a-495b-9201-ef51583aad0d",
"db_language_id": "ab78cf3c-acfe-4f3e-9597-b5aa8f55e55f",
"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-11T16:33:09.9422553+00:00"
},
"modified_dateutc": "2026-09-11T16:33:09.9422553+00:00"
},
"equipment_model_id": "5c9c062f-a86a-4ef0-a802-ad7ebe87785f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9b3435f6-2c8d-4267-ac04-af51a1dcc074",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "af6a9a53-862f-483c-aa17-2f11e331d758",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f49556ab-f22c-4684-8eb1-7df05dff551c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7225452a-8266-433e-90b3-ebab7b03df8c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e2d5b679-8e7e-44e8-9ca1-a8f5e54a751b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04ba40a6-91f3-421f-a1db-fee3af835569",
"db_currency_id": "f61ba35e-496a-495b-9201-ef51583aad0d",
"db_language_id": "ab78cf3c-acfe-4f3e-9597-b5aa8f55e55f",
"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-11T16:33:09.9422553+00:00"
},
"modified_dateutc": "2026-09-11T16:33:09.9422553+00:00"
},
"equipment_family_id": "c55819df-6388-4c55-beef-ec8d9b8b6052",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3a5703b2-0250-4dd3-b706-9ee6fbd7a069",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1e540001-f442-4afc-95d3-ad41e87ceb8d",
"_parent_code": "sample string 6",
"sales_organization_id": "d0524e38-aa28-44e1-89cc-b3b387a339ff",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e2d5b679-8e7e-44e8-9ca1-a8f5e54a751b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04ba40a6-91f3-421f-a1db-fee3af835569",
"db_currency_id": "f61ba35e-496a-495b-9201-ef51583aad0d",
"db_language_id": "ab78cf3c-acfe-4f3e-9597-b5aa8f55e55f",
"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-11T16:33:09.9422553+00:00"
},
"modified_dateutc": "2026-09-11T16:33:09.9422553+00:00"
},
"date_in_production_since": "2026-09-11T16:33:09.9422553+00:00",
"date_out_of_production_since": "2026-09-11T16:33:09.9422553+00:00",
"date_end_support": "2026-09-11T16:33:09.9422553+00:00",
"sales_organization_id": "b1f7ef77-711a-41bc-a1da-4e1b07beab11",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e2d5b679-8e7e-44e8-9ca1-a8f5e54a751b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04ba40a6-91f3-421f-a1db-fee3af835569",
"db_currency_id": "f61ba35e-496a-495b-9201-ef51583aad0d",
"db_language_id": "ab78cf3c-acfe-4f3e-9597-b5aa8f55e55f",
"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-11T16:33:09.9422553+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-11T16:33:09.9422553+00:00"
},
"project_status_id": "f6066732-fd7c-4c60-a83e-0eb973ab787c",
"project_status_code": "sample string 10",
"project_status": {
"id": "2f075225-368e-4cdc-82ba-e6c776453c89",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "90491748-a5a5-49d2-972d-ce477fe9eef8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e2d5b679-8e7e-44e8-9ca1-a8f5e54a751b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04ba40a6-91f3-421f-a1db-fee3af835569",
"db_currency_id": "f61ba35e-496a-495b-9201-ef51583aad0d",
"db_language_id": "ab78cf3c-acfe-4f3e-9597-b5aa8f55e55f",
"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-11T16:33:09.9422553+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T16:33:09.9422553+00:00"
},
"company_id": "41083a8a-804f-453f-ae0e-3702c26f8e79",
"company_code": "sample string 12",
"db_address_id": "39d6b354-9201-4ed0-b5ea-9b988badc7ce",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6dfbca69-2ff7-4694-a27b-f3e11e453b08",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6c38e4ac-eeb3-4bb8-be31-26a0943de061",
"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-11T16:33:09.9422553+00:00",
"date_create": "2026-09-11T16:33:09.9422553+00:00",
"date_update": "2026-09-11T16:33:09.9422553+00:00",
"updated_by_user_id": "bc29191f-1cee-45e8-bda5-2c17ea41098b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-11T16:33:09.9422553+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-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-11T16:33:09.9422553+00:00",
"date_last_job": "2026-09-11T16:33:09.9422553+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-11T16:33:09.9422553+00:00",
"modified_dateutc": "2026-09-11T16:33:09.9422553+00:00",
"is_mobile_installation": true
},
"job_type_id": "50cbe04f-c254-4749-bf16-d8129e052264",
"job_type_code": "sample string 7",
"job_type": {
"id": "59bc720c-c0f8-472b-8b43-980c15dd0a43",
"name": "sample string 2",
"sales_organization_id": "49d37a58-2a0b-4a40-bed2-e12a491bcf8f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-11T16:33:09.9422553+00:00",
"code": "sample string 7"
},
"job_priority_id": "3b741f96-b387-4d43-8bdc-a8d4ff682b06",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "edb5c527-3afd-4515-ac9b-75c1510caa42",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "999c2249-a8fd-4f4c-9358-b0c989008ec2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e2d5b679-8e7e-44e8-9ca1-a8f5e54a751b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04ba40a6-91f3-421f-a1db-fee3af835569",
"db_currency_id": "f61ba35e-496a-495b-9201-ef51583aad0d",
"db_language_id": "ab78cf3c-acfe-4f3e-9597-b5aa8f55e55f",
"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-11T16:33:09.9422553+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T16:33:09.9422553+00:00"
},
"job_status_id": "c4436c5e-0fd7-4808-b8ac-14990722a143",
"job_status_code": "sample string 11",
"db_address_id": "6db0f78c-dc31-4917-845a-59e9cbaab40a",
"contact_id": "5f983e43-2a38-463f-bf8b-1307129de0cf",
"requested_by_company_id": "aa91bf63-364a-446d-a565-71e8493e7bec",
"requested_by_contact_id": "022517b4-255c-41ee-b8b9-3a64b8088db5",
"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-11T16:33:09.9422553+00:00",
"due_date": "2026-09-11T16:33:09.9422553+00:00",
"date_create": "2026-09-11T16:33:09.9422553+00:00",
"date_update": "2026-09-11T16:33:09.9422553+00:00",
"date_closed": "2026-09-11T16:33:09.9422553+00:00",
"suggested_user_id": "8d4345e3-f71a-4de9-b1f6-1d91425f2b65",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3e637230-02b7-49c1-9a05-4fbc973e7eaa",
"db_language_id": "f92cce47-5bc0-46f6-8a5e-c9afe91c41ae",
"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-11T16:33:09.9422553+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a99f094d-7b05-43c8-86c6-18ee06bff28a",
"sales_organization": {
"id": "e2d5b679-8e7e-44e8-9ca1-a8f5e54a751b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04ba40a6-91f3-421f-a1db-fee3af835569",
"db_currency_id": "f61ba35e-496a-495b-9201-ef51583aad0d",
"db_language_id": "ab78cf3c-acfe-4f3e-9597-b5aa8f55e55f",
"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-11T16:33:09.9422553+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6e28515f-5fbe-4ec7-9bbd-ef083dc60cbb",
"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": "b8145c51-776b-4819-aed3-5176bc5a5bf5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-11T16:33:09.9422553+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8f5b3197-f5c0-4a97-99e1-fb38c0fa2ad7"
},
"suggested_date_start": "2026-09-11T16:33:09.9422553+00:00",
"skill_id": "0ccf7d2c-25d7-4efd-a2ef-f40fbf968fef",
"skill_code": "sample string 32",
"skill": {
"id": "e4a188ce-5d7b-4123-93ae-b167f1cf233d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "be2239f9-576c-4824-9a56-4a26e8754a82",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e2d5b679-8e7e-44e8-9ca1-a8f5e54a751b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04ba40a6-91f3-421f-a1db-fee3af835569",
"db_currency_id": "f61ba35e-496a-495b-9201-ef51583aad0d",
"db_language_id": "ab78cf3c-acfe-4f3e-9597-b5aa8f55e55f",
"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-11T16:33:09.9422553+00:00"
},
"modified_dateutc": "2026-09-11T16:33:09.9422553+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "170ef5f1-482e-4093-bbc0-f589921e45dd",
"date_reported_by_company": "2026-09-11T16:33:09.9422553+00:00",
"id2": 36,
"company_id": "b369b591-a85d-493c-ad89-d319a30473d6",
"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": "9c3938ce-2665-425e-a3ef-4f02f9521820",
"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-11T16:33:09.9422553+00:00"
},
"work_instruction_details_id": "5701b0af-1946-4452-b0f7-64f19be9c1bf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dbff98fa-2723-4fff-bb05-f0b7893ebcb4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c5485ccd-8bf2-434a-a388-0f6033dab5ac",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-11T16:33:09.9422553+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": "06dfe971-bfd5-47b8-899d-ebe186f76cf4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-11T16:33:09.9422553+00:00"
}