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": "19e4901c-f516-49d4-90f8-4498fc08a962",
"jobs_id": "0e96d9fe-a0b6-4221-8041-2918b0729f59",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c84ae983-3110-4c13-b751-bb4780f07015",
"_parent_id": "63b30120-7a65-4046-a97d-b4e39afd8fc9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3f9837b8-851b-4cc6-89cc-96a7bb0a3ce0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7d45d6cc-673a-4301-b706-76f7e061b7ab",
"_parent_id": "8eb3859b-39ed-4303-97a1-b339d4872407",
"root_parent_id": "51f43cab-c41d-435d-838b-3043f58e8779",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "63efabdf-0252-46e7-b62e-a47255620ab9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d5275606-3740-42cd-8faa-b5ad0e884bae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "be18ac6c-79e0-47d0-ba97-578034d7e863",
"_parent_code": "sample string 6",
"sales_organization_id": "dc54f7fb-e9f1-4b09-88d4-187d698806dc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "61586802-e78a-433c-afb4-923ff91d1590",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "386d7e39-34bb-4d38-8a71-a419ee968c7e",
"db_currency_id": "f7156a19-ac66-461c-9bc4-5c145386842f",
"db_language_id": "5f055db0-2214-470e-8ad8-d14c54e76b3f",
"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-02-25T21:01:38.6072435+00:00"
},
"modified_dateutc": "2026-02-25T21:01:38.6072435+00:00"
},
"equipment_model_id": "4353b474-1974-43ed-96ef-e92a08307840",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6e0f4c7c-45a5-410f-820a-b8b6178fbd02",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ed6bcd5d-0b5d-4e20-a6dc-c5424a301fea",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "62fa3b74-c9a5-4a2f-9a40-84902a9103ca",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "92d36c9d-712f-4ecc-9695-13f14adc5932",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "61586802-e78a-433c-afb4-923ff91d1590",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "386d7e39-34bb-4d38-8a71-a419ee968c7e",
"db_currency_id": "f7156a19-ac66-461c-9bc4-5c145386842f",
"db_language_id": "5f055db0-2214-470e-8ad8-d14c54e76b3f",
"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-02-25T21:01:38.6072435+00:00"
},
"modified_dateutc": "2026-02-25T21:01:38.6072435+00:00"
},
"equipment_family_id": "c85fc538-86aa-4a02-8f8e-daa022c28738",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d5275606-3740-42cd-8faa-b5ad0e884bae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "be18ac6c-79e0-47d0-ba97-578034d7e863",
"_parent_code": "sample string 6",
"sales_organization_id": "dc54f7fb-e9f1-4b09-88d4-187d698806dc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "61586802-e78a-433c-afb4-923ff91d1590",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "386d7e39-34bb-4d38-8a71-a419ee968c7e",
"db_currency_id": "f7156a19-ac66-461c-9bc4-5c145386842f",
"db_language_id": "5f055db0-2214-470e-8ad8-d14c54e76b3f",
"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-02-25T21:01:38.6072435+00:00"
},
"modified_dateutc": "2026-02-25T21:01:38.6072435+00:00"
},
"date_in_production_since": "2026-02-25T21:01:38.6072435+00:00",
"date_out_of_production_since": "2026-02-25T21:01:38.6072435+00:00",
"date_end_support": "2026-02-25T21:01:38.6072435+00:00",
"sales_organization_id": "b3a7043f-985c-436f-99d6-7a66e47ce27e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "61586802-e78a-433c-afb4-923ff91d1590",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "386d7e39-34bb-4d38-8a71-a419ee968c7e",
"db_currency_id": "f7156a19-ac66-461c-9bc4-5c145386842f",
"db_language_id": "5f055db0-2214-470e-8ad8-d14c54e76b3f",
"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-02-25T21:01:38.6072435+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-02-25T21:01:38.6228693+00:00"
},
"project_status_id": "5b5e9e90-e9b7-4bc4-b488-769932760348",
"project_status_code": "sample string 10",
"project_status": {
"id": "f78512d9-c488-4edd-919b-90456a7add7c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "532f6afe-f6fc-4ceb-b636-a918c98da44a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "61586802-e78a-433c-afb4-923ff91d1590",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "386d7e39-34bb-4d38-8a71-a419ee968c7e",
"db_currency_id": "f7156a19-ac66-461c-9bc4-5c145386842f",
"db_language_id": "5f055db0-2214-470e-8ad8-d14c54e76b3f",
"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-02-25T21:01:38.6072435+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-25T21:01:38.6228693+00:00"
},
"company_id": "ad79c198-34e0-47c1-aa6b-56fe61ddc036",
"company_code": "sample string 12",
"db_address_id": "3d43e370-377a-4ac6-8729-636f546d63de",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e7702b57-3cae-41f2-b365-eee0e0a59efa",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0094511e-dcf4-474d-b3f4-a5d543475280",
"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-02-25T21:01:38.6228693+00:00",
"date_create": "2026-02-25T21:01:38.6228693+00:00",
"date_update": "2026-02-25T21:01:38.6228693+00:00",
"updated_by_user_id": "00848834-e869-4993-b453-5dfd5f673859",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-25T21:01:38.6228693+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-02-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-25T21:01:38.6228693+00:00",
"date_last_job": "2026-02-25T21:01:38.6228693+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-25T21:01:38.6228693+00:00",
"modified_dateutc": "2026-02-25T21:01:38.6228693+00:00",
"is_mobile_installation": true
},
"job_type_id": "3fead20d-659f-43c2-83c0-98237205e721",
"job_type_code": "sample string 7",
"job_type": {
"id": "ef8fd4f4-5a45-4107-89dc-c30680226f39",
"name": "sample string 2",
"sales_organization_id": "90abbd3e-e40f-4f66-9a87-5c4f98148973",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-25T21:01:38.6228693+00:00",
"code": "sample string 7"
},
"job_priority_id": "4509872a-1c9e-48b4-8ec5-4bf48a8b828d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d76206f0-c6aa-4f17-8728-28acfff1f57a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "16c1105e-feb1-4be1-8aad-202c20205211",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "61586802-e78a-433c-afb4-923ff91d1590",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "386d7e39-34bb-4d38-8a71-a419ee968c7e",
"db_currency_id": "f7156a19-ac66-461c-9bc4-5c145386842f",
"db_language_id": "5f055db0-2214-470e-8ad8-d14c54e76b3f",
"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-02-25T21:01:38.6072435+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-25T21:01:38.6228693+00:00"
},
"job_status_id": "b7b44369-2831-4a58-a9f3-8c222189b58f",
"job_status_code": "sample string 11",
"db_address_id": "d14473a4-6c74-409a-9cbd-ecc198c03718",
"contact_id": "0070919a-fb6f-4501-aa4a-14b17deaeb91",
"requested_by_company_id": "a83b6268-bab0-4973-be47-9ec8bc2446ca",
"requested_by_contact_id": "fa04a5b4-970b-413f-a546-ecc5bd93db00",
"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-02-25T21:01:38.6228693+00:00",
"due_date": "2026-02-25T21:01:38.6228693+00:00",
"date_create": "2026-02-25T21:01:38.6228693+00:00",
"date_update": "2026-02-25T21:01:38.6228693+00:00",
"date_closed": "2026-02-25T21:01:38.6228693+00:00",
"suggested_user_id": "677bc2fd-8745-46c7-a888-f9766773dbdf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "53b97fa6-1d0e-4a46-af8a-ed07e7101d1b",
"db_language_id": "44319a75-adae-4da8-968d-33d7486813e3",
"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-02-25T21:01:38.6228693+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c4150a87-2f28-4e2c-a1a5-06bc66d1d6f9",
"sales_organization": {
"id": "61586802-e78a-433c-afb4-923ff91d1590",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "386d7e39-34bb-4d38-8a71-a419ee968c7e",
"db_currency_id": "f7156a19-ac66-461c-9bc4-5c145386842f",
"db_language_id": "5f055db0-2214-470e-8ad8-d14c54e76b3f",
"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-02-25T21:01:38.6072435+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "acb485d9-a333-4b85-a0ab-dca25506f44f",
"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": "2fff8443-30de-4a38-ad8a-f3c248edef9b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-25T21:01:38.6228693+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f3fd9811-37b9-4202-a739-1237985b59f2"
},
"suggested_date_start": "2026-02-25T21:01:38.6228693+00:00",
"skill_id": "593c3dac-2640-4a0b-90bd-d445e7252b90",
"skill_code": "sample string 32",
"skill": {
"id": "bdb0fcc4-bc09-4607-92c3-4a9af8c9e28f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "34ab4ef1-7877-46e3-8a4c-7826567f477d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "61586802-e78a-433c-afb4-923ff91d1590",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "386d7e39-34bb-4d38-8a71-a419ee968c7e",
"db_currency_id": "f7156a19-ac66-461c-9bc4-5c145386842f",
"db_language_id": "5f055db0-2214-470e-8ad8-d14c54e76b3f",
"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-02-25T21:01:38.6072435+00:00"
},
"modified_dateutc": "2026-02-25T21:01:38.6228693+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "23f00e3a-15fb-49a7-a684-e511fb63d066",
"date_reported_by_company": "2026-02-25T21:01:38.6228693+00:00",
"id2": 36,
"company_id": "7bdfd49f-f30a-40ff-b7f7-c50e5ed790bb",
"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": "b6cbe4ee-6ed5-4c96-947f-ccf34378018b",
"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-02-25T21:01:38.6228693+00:00"
},
"work_instruction_details_id": "48719a4c-4c73-4fee-9d6c-2c42a1451b15",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "870d0ac4-7f1e-4171-9292-d0d1a9059449",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0cf876f5-f4fd-4114-9aa6-7e5a1e37a695",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-25T21:01:38.6228693+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": "94a6a1a4-062f-446f-ad64-3bf002e64b6f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-25T21:01:38.6228693+00:00"
}