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": "d84b81a6-4336-405c-82b1-7f2132147584",
"jobs_id": "81a2843a-4f51-4a58-92bb-1ff3aea17fdc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "94b39778-a29a-43e6-8020-efe7e21ae80b",
"_parent_id": "229b2cbd-812b-417f-9c7f-0d9f3a494dc3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "aa6d1c18-61a1-42f7-9db2-4ffe6bde6b8f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d35448ba-9aba-47f3-b78e-1f501f914ff4",
"_parent_id": "a20a56ae-4ba9-4ff6-a8be-d73b52ce7396",
"root_parent_id": "77f2c566-4a6f-4cc4-baa7-782129e304de",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0ea0bb97-6cbe-467b-8ab2-3007f609b7fb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "812eda0d-a5ec-4783-8667-c6bd75e07445",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d43750d1-173a-43a1-8051-03103c2ae505",
"_parent_code": "sample string 6",
"sales_organization_id": "c45e87e9-8ed2-4754-a366-87b8437a3641",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eb28bace-3885-47c0-9d96-5f6d2ca978fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41766dbf-1c36-437d-a4f4-32fa2c64e8c2",
"db_currency_id": "bcad1b38-566a-4f7c-b6b1-ba74f520e03d",
"db_language_id": "6cebcdd0-cf12-4ac8-83f0-2aade4c8b78b",
"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-30T05:06:29.850681+00:00"
},
"modified_dateutc": "2026-09-30T05:06:29.9146051+00:00"
},
"equipment_model_id": "4bd9d08f-7bf0-480f-8935-1c2688ad201a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "90326b49-4ea7-4e6a-9ef6-fd734b82b69e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b122d277-98b4-4702-9dda-09ec14293831",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8c7b5ea8-356f-4518-a0ef-a5603d61ba7b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1fd1f042-68dd-49a9-80bd-e1d027df5287",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eb28bace-3885-47c0-9d96-5f6d2ca978fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41766dbf-1c36-437d-a4f4-32fa2c64e8c2",
"db_currency_id": "bcad1b38-566a-4f7c-b6b1-ba74f520e03d",
"db_language_id": "6cebcdd0-cf12-4ac8-83f0-2aade4c8b78b",
"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-30T05:06:29.850681+00:00"
},
"modified_dateutc": "2026-09-30T05:06:29.9146051+00:00"
},
"equipment_family_id": "a9b80431-7d14-4f4d-a5ae-c3a3332018a6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "812eda0d-a5ec-4783-8667-c6bd75e07445",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d43750d1-173a-43a1-8051-03103c2ae505",
"_parent_code": "sample string 6",
"sales_organization_id": "c45e87e9-8ed2-4754-a366-87b8437a3641",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eb28bace-3885-47c0-9d96-5f6d2ca978fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41766dbf-1c36-437d-a4f4-32fa2c64e8c2",
"db_currency_id": "bcad1b38-566a-4f7c-b6b1-ba74f520e03d",
"db_language_id": "6cebcdd0-cf12-4ac8-83f0-2aade4c8b78b",
"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-30T05:06:29.850681+00:00"
},
"modified_dateutc": "2026-09-30T05:06:29.9146051+00:00"
},
"date_in_production_since": "2026-09-30T05:06:29.9146051+00:00",
"date_out_of_production_since": "2026-09-30T05:06:29.9146051+00:00",
"date_end_support": "2026-09-30T05:06:29.9146051+00:00",
"sales_organization_id": "d34a19b3-bd6e-4182-adaa-d2ca1c340d40",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "eb28bace-3885-47c0-9d96-5f6d2ca978fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41766dbf-1c36-437d-a4f4-32fa2c64e8c2",
"db_currency_id": "bcad1b38-566a-4f7c-b6b1-ba74f520e03d",
"db_language_id": "6cebcdd0-cf12-4ac8-83f0-2aade4c8b78b",
"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-30T05:06:29.850681+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-30T05:06:29.9302356+00:00"
},
"project_status_id": "6bd30477-b970-44b2-8732-ba189381d248",
"project_status_code": "sample string 10",
"project_status": {
"id": "ad3fe23b-9486-4e3d-a8ce-e91c7b9104a0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0afbccf2-8589-41df-8177-414b5048a3f4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb28bace-3885-47c0-9d96-5f6d2ca978fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41766dbf-1c36-437d-a4f4-32fa2c64e8c2",
"db_currency_id": "bcad1b38-566a-4f7c-b6b1-ba74f520e03d",
"db_language_id": "6cebcdd0-cf12-4ac8-83f0-2aade4c8b78b",
"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-30T05:06:29.850681+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T05:06:29.9302356+00:00"
},
"company_id": "6b46b9ab-b722-4316-a1d6-65f88528e093",
"company_code": "sample string 12",
"db_address_id": "9fd7c82b-6598-4e59-8462-f70b6da5b097",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1e4edfdc-cb30-4e87-ab58-e05dec5774dd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f456ce87-a221-4b7b-b57d-8513a4772c94",
"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-30T05:06:29.9302356+00:00",
"date_create": "2026-09-30T05:06:29.9302356+00:00",
"date_update": "2026-09-30T05:06:29.9302356+00:00",
"updated_by_user_id": "8f7d2386-20f8-4fd7-89cd-f0eb79413be0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-30T05:06:29.9302356+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-30T05:06:29.9458756+00:00",
"date_last_job": "2026-09-30T05:06:29.9458756+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-30T05:06:29.9458756+00:00",
"modified_dateutc": "2026-09-30T05:06:29.9458756+00:00",
"is_mobile_installation": true
},
"job_type_id": "8a3299e3-14d7-4d1d-b507-68b8950b2bad",
"job_type_code": "sample string 7",
"job_type": {
"id": "18efb1b1-bcee-47c4-a8d0-a2da93c438f6",
"name": "sample string 2",
"sales_organization_id": "8a0a4fe5-858f-4e18-8948-87d85f790592",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-30T05:06:29.9458756+00:00",
"code": "sample string 7"
},
"job_priority_id": "83fa5b0c-475c-4133-9fe1-66b41af6a13c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "17131ddc-6608-479c-95f6-b2dada3c3bca",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "74cdf2ed-0c4d-4041-a4f6-df314e345f39",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb28bace-3885-47c0-9d96-5f6d2ca978fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41766dbf-1c36-437d-a4f4-32fa2c64e8c2",
"db_currency_id": "bcad1b38-566a-4f7c-b6b1-ba74f520e03d",
"db_language_id": "6cebcdd0-cf12-4ac8-83f0-2aade4c8b78b",
"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-30T05:06:29.850681+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T05:06:29.9458756+00:00"
},
"job_status_id": "51fb266d-000c-47fe-a81a-7673e5b6b0b0",
"job_status_code": "sample string 11",
"db_address_id": "a2d44081-778b-487f-8556-ae3fb40985f2",
"contact_id": "f8aa76a6-ff58-4e60-9cd8-319bb89c7519",
"requested_by_company_id": "2ddf517b-9e93-4fc0-b54d-d6358f9ed041",
"requested_by_contact_id": "a1a505dd-b709-44a2-b10b-a0cfb1d0e925",
"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-30T05:06:29.9458756+00:00",
"due_date": "2026-09-30T05:06:29.9458756+00:00",
"date_create": "2026-09-30T05:06:29.9458756+00:00",
"date_update": "2026-09-30T05:06:29.9458756+00:00",
"date_closed": "2026-09-30T05:06:29.9458756+00:00",
"suggested_user_id": "9796d812-34df-4f20-a682-cd45d912279c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f3b68984-b8a9-4210-aa1e-53d64ab3d070",
"db_language_id": "60d663d7-c655-4f07-91e6-dc9fd71836ca",
"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-30T05:06:29.9458756+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8120b0b0-dea6-4086-bce8-576b79f8ab56",
"sales_organization": {
"id": "eb28bace-3885-47c0-9d96-5f6d2ca978fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41766dbf-1c36-437d-a4f4-32fa2c64e8c2",
"db_currency_id": "bcad1b38-566a-4f7c-b6b1-ba74f520e03d",
"db_language_id": "6cebcdd0-cf12-4ac8-83f0-2aade4c8b78b",
"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-30T05:06:29.850681+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "10f631f6-a85f-48a4-aa65-b22a795ac6f5",
"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": "a661a454-360a-4ee1-bc2f-dbebd1c3bbd7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-30T05:06:29.9458756+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6ee0e5c5-f07d-4e9a-8961-77cb32851e45"
},
"suggested_date_start": "2026-09-30T05:06:29.9458756+00:00",
"skill_id": "195161c1-34b1-4d3c-9444-a8ad195d27cc",
"skill_code": "sample string 32",
"skill": {
"id": "8295a4ec-3242-435e-ba56-c25f665847ef",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fe4d04fe-e6e9-44e8-848d-3f669a0d2636",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb28bace-3885-47c0-9d96-5f6d2ca978fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41766dbf-1c36-437d-a4f4-32fa2c64e8c2",
"db_currency_id": "bcad1b38-566a-4f7c-b6b1-ba74f520e03d",
"db_language_id": "6cebcdd0-cf12-4ac8-83f0-2aade4c8b78b",
"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-30T05:06:29.850681+00:00"
},
"modified_dateutc": "2026-09-30T05:06:29.9458756+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ee567c7c-d2be-4481-b3c0-f9527649db12",
"date_reported_by_company": "2026-09-30T05:06:29.9458756+00:00",
"id2": 36,
"company_id": "b84965ad-b63c-4326-9bae-76173c325b4a",
"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": "7198657e-d515-4858-9039-18ba32a61435",
"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-30T05:06:29.9645171+00:00"
},
"work_instruction_details_id": "8bd1517d-0a4b-42bf-a653-556aa7a245da",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "97521994-fa37-4261-89ec-152508303cea",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9f98c5dd-ddc6-45a8-adcb-b83e072ad213",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-30T05:06:29.9645171+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": "39119bf5-5b4a-4a0f-8ab7-0982e4be0907",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-30T05:06:29.9645171+00:00"
}