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": "b0b4c8f4-a52b-4efc-bfd4-7206cf1938ee",
"jobs_id": "e7dc7dd0-25bc-4ed9-816c-720e86015e03",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f014a873-d614-4815-b6f5-b5dd7f2f6b2a",
"_parent_id": "ed7e0738-99f3-442f-b573-24b651db8ca7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8b87ddde-9c5d-4162-8851-1681101904a6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1c31cac9-ac2d-419f-84e8-2eb21a090263",
"_parent_id": "c7e300c4-b658-4667-9dc3-62d2cb461238",
"root_parent_id": "b1666be6-7bda-46aa-9469-55b3b804b5e0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5f55d178-aba0-416f-aef4-840d6f4343e7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "199ec594-449a-4cc7-959b-112ec202ef96",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "45d36405-9570-40e7-b63b-fdf9bbe09bee",
"_parent_code": "sample string 6",
"sales_organization_id": "29343c1d-4ebd-40a3-9acc-15a5edf87928",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74725412-7231-4e2d-b54d-5e5007c3af77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e571dcc-3304-4527-8120-1cd1c9362baa",
"db_currency_id": "39b04af1-0f9d-4945-acb6-70eddcb86bcf",
"db_language_id": "01bd4062-7eb6-4433-b7ee-9f599ab4d7ff",
"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-23T22:10:15.7988495+00:00"
},
"modified_dateutc": "2026-04-23T22:10:15.8144727+00:00"
},
"equipment_model_id": "3b82dad7-a2ee-4174-8668-b983e9572305",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5ad0151c-c5f8-47de-93e9-a5b535537c94",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2df8669e-d24f-463d-b12f-76f8fdb71600",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d1a3874e-485b-4488-b733-86480a2475de",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0b631b5f-7522-44e5-8ce9-06d37587e96a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "74725412-7231-4e2d-b54d-5e5007c3af77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e571dcc-3304-4527-8120-1cd1c9362baa",
"db_currency_id": "39b04af1-0f9d-4945-acb6-70eddcb86bcf",
"db_language_id": "01bd4062-7eb6-4433-b7ee-9f599ab4d7ff",
"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-23T22:10:15.7988495+00:00"
},
"modified_dateutc": "2026-04-23T22:10:15.8144727+00:00"
},
"equipment_family_id": "983c827e-0e21-428b-9cf5-0edb6875d456",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "199ec594-449a-4cc7-959b-112ec202ef96",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "45d36405-9570-40e7-b63b-fdf9bbe09bee",
"_parent_code": "sample string 6",
"sales_organization_id": "29343c1d-4ebd-40a3-9acc-15a5edf87928",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74725412-7231-4e2d-b54d-5e5007c3af77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e571dcc-3304-4527-8120-1cd1c9362baa",
"db_currency_id": "39b04af1-0f9d-4945-acb6-70eddcb86bcf",
"db_language_id": "01bd4062-7eb6-4433-b7ee-9f599ab4d7ff",
"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-23T22:10:15.7988495+00:00"
},
"modified_dateutc": "2026-04-23T22:10:15.8144727+00:00"
},
"date_in_production_since": "2026-04-23T22:10:15.8144727+00:00",
"date_out_of_production_since": "2026-04-23T22:10:15.8144727+00:00",
"date_end_support": "2026-04-23T22:10:15.8144727+00:00",
"sales_organization_id": "c01aa90b-8a29-4b65-ac75-a09b443eb560",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "74725412-7231-4e2d-b54d-5e5007c3af77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e571dcc-3304-4527-8120-1cd1c9362baa",
"db_currency_id": "39b04af1-0f9d-4945-acb6-70eddcb86bcf",
"db_language_id": "01bd4062-7eb6-4433-b7ee-9f599ab4d7ff",
"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-23T22:10:15.7988495+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-23T22:10:15.8144727+00:00"
},
"project_status_id": "7b290e5d-2f8a-4946-9586-a904cf573fb9",
"project_status_code": "sample string 10",
"project_status": {
"id": "3bdb2e71-3ae6-4d7d-954f-404a7448e705",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "51d66c19-8a50-450c-a9d8-6f87159c437d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74725412-7231-4e2d-b54d-5e5007c3af77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e571dcc-3304-4527-8120-1cd1c9362baa",
"db_currency_id": "39b04af1-0f9d-4945-acb6-70eddcb86bcf",
"db_language_id": "01bd4062-7eb6-4433-b7ee-9f599ab4d7ff",
"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-23T22:10:15.7988495+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-23T22:10:15.8144727+00:00"
},
"company_id": "8113143e-00a9-4aa8-be6f-48e88e0311b9",
"company_code": "sample string 12",
"db_address_id": "15d6979d-6d58-41eb-a478-e69cabb3831e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f0972480-b1e2-4927-b487-cfaeba26a309",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e9218a4b-f0c2-4561-bc74-3762c742a393",
"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-23T22:10:15.8301107+00:00",
"date_create": "2026-04-23T22:10:15.8301107+00:00",
"date_update": "2026-04-23T22:10:15.8301107+00:00",
"updated_by_user_id": "bd04375a-2414-45b8-b30e-60a5e3f119ed",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-23T22:10:15.8301107+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-23T22:10:15.8301107+00:00",
"date_last_job": "2026-04-23T22:10:15.8301107+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-23T22:10:15.8301107+00:00",
"modified_dateutc": "2026-04-23T22:10:15.8301107+00:00",
"is_mobile_installation": true
},
"job_type_id": "8f80c841-50ad-4002-89d4-fe905a0f417d",
"job_type_code": "sample string 7",
"job_type": {
"id": "6bcad213-f7f2-48de-9294-deda97f3bc9c",
"name": "sample string 2",
"sales_organization_id": "99141206-3a48-4dac-9fd5-ec72fcec6c73",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-23T22:10:15.8301107+00:00",
"code": "sample string 7"
},
"job_priority_id": "dffd028d-3022-4506-b176-f8364b8a95b9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c189cb92-cf49-43a3-9c1c-32e743e1c641",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7295737d-9454-4ff7-86d0-2b5b0a1e3333",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74725412-7231-4e2d-b54d-5e5007c3af77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e571dcc-3304-4527-8120-1cd1c9362baa",
"db_currency_id": "39b04af1-0f9d-4945-acb6-70eddcb86bcf",
"db_language_id": "01bd4062-7eb6-4433-b7ee-9f599ab4d7ff",
"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-23T22:10:15.7988495+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-23T22:10:15.8301107+00:00"
},
"job_status_id": "ede8c281-12dd-4774-8b8e-e24fa4376e0f",
"job_status_code": "sample string 11",
"db_address_id": "a9869b2c-ea24-47f5-ae55-418d6c0f1094",
"contact_id": "5ea35f90-6854-4024-9765-daba696aef71",
"requested_by_company_id": "ea068efa-ff36-4ca9-b145-19a556a24cf0",
"requested_by_contact_id": "f1fc9ee3-a4cc-420e-a853-f7bbfa1bb12f",
"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-23T22:10:15.8301107+00:00",
"due_date": "2026-04-23T22:10:15.8301107+00:00",
"date_create": "2026-04-23T22:10:15.8301107+00:00",
"date_update": "2026-04-23T22:10:15.8301107+00:00",
"date_closed": "2026-04-23T22:10:15.8301107+00:00",
"suggested_user_id": "0455351a-fd40-4c4d-8a08-398303915a59",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "27752330-bbcc-4560-84fa-00de55a8d8f5",
"db_language_id": "4853d7cb-8f40-4305-9d11-b70d873356eb",
"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-23T22:10:15.8301107+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cbed499d-a68f-4dde-87b8-5774c1cbb5b6",
"sales_organization": {
"id": "74725412-7231-4e2d-b54d-5e5007c3af77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e571dcc-3304-4527-8120-1cd1c9362baa",
"db_currency_id": "39b04af1-0f9d-4945-acb6-70eddcb86bcf",
"db_language_id": "01bd4062-7eb6-4433-b7ee-9f599ab4d7ff",
"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-23T22:10:15.7988495+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "62f4978f-cc1c-4ba9-95b6-d9b7e61d362e",
"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": "07bcfd5a-9e57-4700-9510-7e1510da3b31",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-23T22:10:15.8301107+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "95704dd6-5daf-422d-8c64-b6dfcde711c5"
},
"suggested_date_start": "2026-04-23T22:10:15.8301107+00:00",
"skill_id": "5dccfc94-7347-4ae8-b1d6-30d0574351aa",
"skill_code": "sample string 32",
"skill": {
"id": "c4986828-6d42-4e8a-a09b-5e7490d39993",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "dfd55db3-93d1-45eb-8ae8-2ca7efd1e99b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74725412-7231-4e2d-b54d-5e5007c3af77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e571dcc-3304-4527-8120-1cd1c9362baa",
"db_currency_id": "39b04af1-0f9d-4945-acb6-70eddcb86bcf",
"db_language_id": "01bd4062-7eb6-4433-b7ee-9f599ab4d7ff",
"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-23T22:10:15.7988495+00:00"
},
"modified_dateutc": "2026-04-23T22:10:15.8301107+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6a7df19d-4135-41f2-bf98-f76843a86806",
"date_reported_by_company": "2026-04-23T22:10:15.8301107+00:00",
"id2": 36,
"company_id": "444300b3-3e2e-4387-89b6-1db13d2f1ab5",
"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": "dae48159-244c-4984-bca5-4f40d2d1a018",
"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-23T22:10:15.8301107+00:00"
},
"work_instruction_details_id": "512fb03a-7376-433e-acb7-4adcdb9d0868",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c5c8441b-6eea-4cc8-8354-8bb3469c81a0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2fe2a90d-1488-40b3-8768-4658e8959503",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-23T22:10:15.8301107+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": "7aa49395-fbd3-4657-8c8a-db67807b372d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-23T22:10:15.8301107+00:00"
}