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": "1a639630-b283-41fc-a9c6-b3705522b3ca",
"jobs_id": "01d458f9-b2e7-4da1-b809-7b1349510a48",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "32d3041f-0b20-4fba-a30b-7f6cc7e13c7c",
"_parent_id": "80707f56-c8e8-443a-a073-7673f8b452b5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b011760e-713e-4236-9787-dd0a79280f42",
"project_reference_back_office": "sample string 5",
"project": {
"id": "433ce71f-d532-4797-ae92-454ff0eefb45",
"_parent_id": "9a15724c-39a5-4a87-a624-a75676fdaaeb",
"root_parent_id": "2b2bf63e-83c4-4e02-992b-3cd712cb718a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3abcabf4-bf5d-43d4-9f75-abc8b6c09da4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f0048567-cbcf-4137-9d1a-7692b87567ae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7616d213-098c-407d-b617-f7afe0a89a65",
"_parent_code": "sample string 6",
"sales_organization_id": "4ef8daf0-2b8e-4306-854b-6c39637ea1be",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d741a77c-4454-4a48-a9f7-c86ac1cb4dc6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c4c9a4-1e10-4ee0-906c-f1f2724f46b2",
"db_currency_id": "71567f57-79c5-4002-a876-f1821b32c0e2",
"db_language_id": "2bf9b721-cefb-4cd2-9e95-d6961dc6685c",
"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-08-10T23:51:24.2797614+00:00"
},
"modified_dateutc": "2026-08-10T23:51:24.2797614+00:00"
},
"equipment_model_id": "0a19ea6a-63bd-4e48-9ab7-92415e17a1eb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3da6e45e-383c-4b4f-8dd1-59fe8f26ca25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7bed0fe9-8660-41d5-aa3f-5c717b82afbb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "26a5b896-a0c5-4268-bd71-077fb67768d1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b0ff3774-13bd-431d-9bb1-563906ce0f1a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d741a77c-4454-4a48-a9f7-c86ac1cb4dc6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c4c9a4-1e10-4ee0-906c-f1f2724f46b2",
"db_currency_id": "71567f57-79c5-4002-a876-f1821b32c0e2",
"db_language_id": "2bf9b721-cefb-4cd2-9e95-d6961dc6685c",
"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-08-10T23:51:24.2797614+00:00"
},
"modified_dateutc": "2026-08-10T23:51:24.2797614+00:00"
},
"equipment_family_id": "42bc1c80-362a-4aaf-8170-62313e556f11",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f0048567-cbcf-4137-9d1a-7692b87567ae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7616d213-098c-407d-b617-f7afe0a89a65",
"_parent_code": "sample string 6",
"sales_organization_id": "4ef8daf0-2b8e-4306-854b-6c39637ea1be",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d741a77c-4454-4a48-a9f7-c86ac1cb4dc6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c4c9a4-1e10-4ee0-906c-f1f2724f46b2",
"db_currency_id": "71567f57-79c5-4002-a876-f1821b32c0e2",
"db_language_id": "2bf9b721-cefb-4cd2-9e95-d6961dc6685c",
"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-08-10T23:51:24.2797614+00:00"
},
"modified_dateutc": "2026-08-10T23:51:24.2797614+00:00"
},
"date_in_production_since": "2026-08-10T23:51:24.2797614+00:00",
"date_out_of_production_since": "2026-08-10T23:51:24.2797614+00:00",
"date_end_support": "2026-08-10T23:51:24.2797614+00:00",
"sales_organization_id": "22194403-bc3e-408f-a3c9-6c1c4cbe85e6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d741a77c-4454-4a48-a9f7-c86ac1cb4dc6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c4c9a4-1e10-4ee0-906c-f1f2724f46b2",
"db_currency_id": "71567f57-79c5-4002-a876-f1821b32c0e2",
"db_language_id": "2bf9b721-cefb-4cd2-9e95-d6961dc6685c",
"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-08-10T23:51:24.2797614+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-08-10T23:51:24.2797614+00:00"
},
"project_status_id": "f76b0b3e-cbd4-4b29-9fab-a920356b1b40",
"project_status_code": "sample string 10",
"project_status": {
"id": "fef730c9-e682-42f9-a08c-4e1b1e905b96",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "875d8313-1d82-4989-930c-5d4ed94df210",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d741a77c-4454-4a48-a9f7-c86ac1cb4dc6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c4c9a4-1e10-4ee0-906c-f1f2724f46b2",
"db_currency_id": "71567f57-79c5-4002-a876-f1821b32c0e2",
"db_language_id": "2bf9b721-cefb-4cd2-9e95-d6961dc6685c",
"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-08-10T23:51:24.2797614+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-10T23:51:24.2797614+00:00"
},
"company_id": "93ad2991-b735-4378-a3b7-dc7510f04ea4",
"company_code": "sample string 12",
"db_address_id": "fc80200e-f009-49f9-acf4-ee988e22217c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "60b787bf-c6f8-435d-930d-3ce26cd6ee89",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "19098b7b-96df-463f-a3aa-0cf7ce564b2d",
"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-08-10T23:51:24.2797614+00:00",
"date_create": "2026-08-10T23:51:24.2797614+00:00",
"date_update": "2026-08-10T23:51:24.2797614+00:00",
"updated_by_user_id": "3347c389-ba63-4e74-90c2-f397b5df8279",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-10T23:51:24.2797614+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-08-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-10T23:51:24.2797614+00:00",
"date_last_job": "2026-08-10T23:51:24.2797614+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-10T23:51:24.2797614+00:00",
"modified_dateutc": "2026-08-10T23:51:24.2797614+00:00",
"is_mobile_installation": true
},
"job_type_id": "e3f97e0b-6378-47f7-a030-23048276510b",
"job_type_code": "sample string 7",
"job_type": {
"id": "a6412747-7ddf-4b36-891b-6e9d6fcdf911",
"name": "sample string 2",
"sales_organization_id": "1cfb14f4-0528-41cc-9fac-cd56afeec33b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-10T23:51:24.2797614+00:00",
"code": "sample string 7"
},
"job_priority_id": "03525602-7bed-4463-beee-f977e522c25a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a97f3041-a2a5-42a8-bdd2-66535391c543",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d178c430-bf25-48e7-ad2a-fcce2cdc973c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d741a77c-4454-4a48-a9f7-c86ac1cb4dc6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c4c9a4-1e10-4ee0-906c-f1f2724f46b2",
"db_currency_id": "71567f57-79c5-4002-a876-f1821b32c0e2",
"db_language_id": "2bf9b721-cefb-4cd2-9e95-d6961dc6685c",
"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-08-10T23:51:24.2797614+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-10T23:51:24.2797614+00:00"
},
"job_status_id": "7de59971-de4c-4622-8634-c417b3cdd523",
"job_status_code": "sample string 11",
"db_address_id": "a4d9584a-119b-4d44-ac7b-cf82c33efcbc",
"contact_id": "d6ec0bb5-8e85-403a-8222-795a254917a9",
"requested_by_company_id": "e1b538eb-127e-4d4d-aaef-8acbd6ba54d6",
"requested_by_contact_id": "c4077c9a-4f28-4cae-9b19-9ec8e5fda839",
"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-08-10T23:51:24.2797614+00:00",
"due_date": "2026-08-10T23:51:24.2797614+00:00",
"date_create": "2026-08-10T23:51:24.2797614+00:00",
"date_update": "2026-08-10T23:51:24.2797614+00:00",
"date_closed": "2026-08-10T23:51:24.2797614+00:00",
"suggested_user_id": "ae688058-3dfe-4c4e-8d0a-27c533835dfe",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "52f73576-d788-4f4a-9cd2-dc7a3fa66309",
"db_language_id": "475ed47c-9849-48bb-8786-6e799b07ccee",
"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-08-10T23:51:24.2797614+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b1cdeb18-b59d-4ec8-9336-63e4b5d80811",
"sales_organization": {
"id": "d741a77c-4454-4a48-a9f7-c86ac1cb4dc6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c4c9a4-1e10-4ee0-906c-f1f2724f46b2",
"db_currency_id": "71567f57-79c5-4002-a876-f1821b32c0e2",
"db_language_id": "2bf9b721-cefb-4cd2-9e95-d6961dc6685c",
"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-08-10T23:51:24.2797614+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4e8b2236-53b0-46bb-9ee9-e319ba621ecf",
"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": "7373779a-db91-4c3b-952f-acfe3e971a6a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-10T23:51:24.2797614+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6ea8a7ee-c9c1-4e5c-8695-82d02862791d"
},
"suggested_date_start": "2026-08-10T23:51:24.2797614+00:00",
"skill_id": "dca437ad-9cc7-46b7-ba07-28950e8f13c5",
"skill_code": "sample string 32",
"skill": {
"id": "5813d0a0-8847-4c17-9953-43b881ba0f90",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d13b4d67-80ff-4154-85bf-8310749b8ff3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d741a77c-4454-4a48-a9f7-c86ac1cb4dc6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c4c9a4-1e10-4ee0-906c-f1f2724f46b2",
"db_currency_id": "71567f57-79c5-4002-a876-f1821b32c0e2",
"db_language_id": "2bf9b721-cefb-4cd2-9e95-d6961dc6685c",
"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-08-10T23:51:24.2797614+00:00"
},
"modified_dateutc": "2026-08-10T23:51:24.2797614+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0c33e150-f890-4f27-9873-81f89071f07b",
"date_reported_by_company": "2026-08-10T23:51:24.2797614+00:00",
"id2": 36,
"company_id": "9aea9968-dd3c-4d03-b1fb-1e1aa784e314",
"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": "66cf0e71-2b51-4cba-8a29-2a194c39f68d",
"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-08-10T23:51:24.2797614+00:00"
},
"work_instruction_details_id": "5a14da04-00c9-48ca-b69f-3b2e14a53594",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2e4c5d3f-2013-4a76-affa-4016a90b0f26",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f8c1a2d8-e49b-4142-82d6-f337b34f1d37",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-10T23:51:24.2797614+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": "5f95fe4b-89f2-4693-a1db-2d123d05047b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-10T23:51:24.2797614+00:00"
}