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": "742ab66f-785f-4246-9175-fe4bdaf72ecd",
"jobs_id": "4076b6f6-f321-48d2-a3b9-ec4f1c24b096",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0c16066d-d9b6-4377-abbc-7dbdc19c70c9",
"_parent_id": "49986e5f-b8c5-4c8c-ac3e-381345bba9d7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "72edebc4-fd74-4e0b-a442-fce13b7c8b12",
"project_reference_back_office": "sample string 5",
"project": {
"id": "136c1030-fc71-4b18-8c5b-d044f877ecbb",
"_parent_id": "c5992a1b-e79d-4da8-abcd-3747e6e39686",
"root_parent_id": "52acc90a-b6be-4a73-b2e9-c7da9fd53982",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ac2ca47e-0aaa-476d-8bf1-79396bd4b15f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5279f9fd-537e-4629-a6a5-77c870421e1f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dfa05ba4-7df9-4cfc-9f3d-742ffaf32b35",
"_parent_code": "sample string 6",
"sales_organization_id": "8cebe4f1-67be-4b57-8779-71126f2d3c30",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7617fbb-6c45-4aa4-859d-8a6d12078165",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a76e4d3-7808-4293-917e-b61ef03c5957",
"db_currency_id": "5d81eee4-9792-46c4-b203-277b2e620ffd",
"db_language_id": "5efd87c7-4e4c-40cd-b761-df69a2dd25b8",
"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-03-05T15:44:34.2464993+00:00"
},
"modified_dateutc": "2026-03-05T15:44:34.2464993+00:00"
},
"equipment_model_id": "46286faa-51c3-4e3f-9ce4-822b0defc1ad",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "718ab58e-015d-4e3e-831f-5930eda5c68b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "34ce5c29-0a53-4c3f-a1b4-0272934abc4a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6b0f06c2-d415-4f59-a38c-1ae610113184",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "123a1df2-52e7-452a-a826-576578d3db8d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d7617fbb-6c45-4aa4-859d-8a6d12078165",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a76e4d3-7808-4293-917e-b61ef03c5957",
"db_currency_id": "5d81eee4-9792-46c4-b203-277b2e620ffd",
"db_language_id": "5efd87c7-4e4c-40cd-b761-df69a2dd25b8",
"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-03-05T15:44:34.2464993+00:00"
},
"modified_dateutc": "2026-03-05T15:44:34.2464993+00:00"
},
"equipment_family_id": "619be97e-fac6-430a-9713-476c1c55c43f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5279f9fd-537e-4629-a6a5-77c870421e1f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dfa05ba4-7df9-4cfc-9f3d-742ffaf32b35",
"_parent_code": "sample string 6",
"sales_organization_id": "8cebe4f1-67be-4b57-8779-71126f2d3c30",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7617fbb-6c45-4aa4-859d-8a6d12078165",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a76e4d3-7808-4293-917e-b61ef03c5957",
"db_currency_id": "5d81eee4-9792-46c4-b203-277b2e620ffd",
"db_language_id": "5efd87c7-4e4c-40cd-b761-df69a2dd25b8",
"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-03-05T15:44:34.2464993+00:00"
},
"modified_dateutc": "2026-03-05T15:44:34.2464993+00:00"
},
"date_in_production_since": "2026-03-05T15:44:34.2464993+00:00",
"date_out_of_production_since": "2026-03-05T15:44:34.2464993+00:00",
"date_end_support": "2026-03-05T15:44:34.2464993+00:00",
"sales_organization_id": "5fea473e-69cc-4fe6-9428-d74fbbad9eda",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d7617fbb-6c45-4aa4-859d-8a6d12078165",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a76e4d3-7808-4293-917e-b61ef03c5957",
"db_currency_id": "5d81eee4-9792-46c4-b203-277b2e620ffd",
"db_language_id": "5efd87c7-4e4c-40cd-b761-df69a2dd25b8",
"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-03-05T15:44:34.2464993+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-03-05T15:44:34.2621234+00:00"
},
"project_status_id": "419c494c-6c68-42c8-90be-c45f316330d7",
"project_status_code": "sample string 10",
"project_status": {
"id": "9a524b58-7ae8-4fcc-8de9-00cbfd096795",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "23610127-7e24-4dcf-a7fc-81ba31bd4f5f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7617fbb-6c45-4aa4-859d-8a6d12078165",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a76e4d3-7808-4293-917e-b61ef03c5957",
"db_currency_id": "5d81eee4-9792-46c4-b203-277b2e620ffd",
"db_language_id": "5efd87c7-4e4c-40cd-b761-df69a2dd25b8",
"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-03-05T15:44:34.2464993+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-05T15:44:34.2621234+00:00"
},
"company_id": "fe059ca7-dea9-46b6-8e25-acc9813496f8",
"company_code": "sample string 12",
"db_address_id": "b3a39f92-f0fc-4e28-924b-2d5df092165c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9aa618d6-fe2f-4da3-b2fb-3d6914f825d4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9055a589-a014-4986-98c5-73cc32244a04",
"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-03-05T15:44:34.2621234+00:00",
"date_create": "2026-03-05T15:44:34.2621234+00:00",
"date_update": "2026-03-05T15:44:34.2621234+00:00",
"updated_by_user_id": "fe3857f9-7235-469d-868e-ae48d889b9ed",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-05T15:44:34.2621234+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-03-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-05T15:44:34.2621234+00:00",
"date_last_job": "2026-03-05T15:44:34.2621234+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-05T15:44:34.2621234+00:00",
"modified_dateutc": "2026-03-05T15:44:34.2621234+00:00",
"is_mobile_installation": true
},
"job_type_id": "dd7656c0-46ef-4220-9148-3e041c184be0",
"job_type_code": "sample string 7",
"job_type": {
"id": "1a04af6a-085c-421a-8204-6f8c2452b45d",
"name": "sample string 2",
"sales_organization_id": "569a7754-4a23-408c-bd88-7aeacab936ee",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-05T15:44:34.2621234+00:00",
"code": "sample string 7"
},
"job_priority_id": "eab7b3c9-0e8f-49ad-9211-2ce5efaf6bce",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0c53da4a-1421-41e2-addc-55feb5f65a2b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ff28d3ef-fc00-4a72-b102-520264ea9154",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7617fbb-6c45-4aa4-859d-8a6d12078165",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a76e4d3-7808-4293-917e-b61ef03c5957",
"db_currency_id": "5d81eee4-9792-46c4-b203-277b2e620ffd",
"db_language_id": "5efd87c7-4e4c-40cd-b761-df69a2dd25b8",
"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-03-05T15:44:34.2464993+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-05T15:44:34.2621234+00:00"
},
"job_status_id": "b91f4397-9a49-438a-be15-43792b00a58d",
"job_status_code": "sample string 11",
"db_address_id": "eb21783b-1f90-44ee-a199-28208a72d926",
"contact_id": "c2a66668-6f29-423c-b163-47a4f9a35996",
"requested_by_company_id": "6e0eb3fb-069f-47a7-a861-8fbe45813241",
"requested_by_contact_id": "c78d037b-7fba-4911-8466-b8b20bc48bea",
"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-03-05T15:44:34.2621234+00:00",
"due_date": "2026-03-05T15:44:34.2621234+00:00",
"date_create": "2026-03-05T15:44:34.2621234+00:00",
"date_update": "2026-03-05T15:44:34.2621234+00:00",
"date_closed": "2026-03-05T15:44:34.2621234+00:00",
"suggested_user_id": "fef0be13-8df3-439f-89ed-fad4f82c294f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2544c9ac-1be3-4168-b860-88e2ba333315",
"db_language_id": "865dcb5e-25bc-4cdd-a434-64d388f4d65c",
"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-03-05T15:44:34.2621234+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bddaab93-c4bf-44cb-86a3-6047f9fa89f4",
"sales_organization": {
"id": "d7617fbb-6c45-4aa4-859d-8a6d12078165",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a76e4d3-7808-4293-917e-b61ef03c5957",
"db_currency_id": "5d81eee4-9792-46c4-b203-277b2e620ffd",
"db_language_id": "5efd87c7-4e4c-40cd-b761-df69a2dd25b8",
"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-03-05T15:44:34.2464993+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2a34f545-bde0-46fa-bbb6-6abc260270fc",
"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": "6730a050-027c-4a5d-92eb-cecf14833198",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-05T15:44:34.2621234+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a5b12277-a3c6-4f9a-abfe-5b114b84437f"
},
"suggested_date_start": "2026-03-05T15:44:34.2621234+00:00",
"skill_id": "27a527a5-3eb9-4349-b1b7-1a48c813e0c2",
"skill_code": "sample string 32",
"skill": {
"id": "7ee0d166-2b33-435a-9dfc-59966543c21f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4addd10f-3599-4659-8ca5-31548137103a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7617fbb-6c45-4aa4-859d-8a6d12078165",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a76e4d3-7808-4293-917e-b61ef03c5957",
"db_currency_id": "5d81eee4-9792-46c4-b203-277b2e620ffd",
"db_language_id": "5efd87c7-4e4c-40cd-b761-df69a2dd25b8",
"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-03-05T15:44:34.2464993+00:00"
},
"modified_dateutc": "2026-03-05T15:44:34.2621234+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2a72c234-69a4-4f7e-b71e-5ac8aab29776",
"date_reported_by_company": "2026-03-05T15:44:34.2621234+00:00",
"id2": 36,
"company_id": "65f92692-ce81-4094-95af-005968fc2058",
"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": "d993da50-09a5-4f1b-b29f-a06dec8f074e",
"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-03-05T15:44:34.2621234+00:00"
},
"work_instruction_details_id": "c0ef6bc0-c9d8-4551-b1cf-97057c3af65e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1c29d4b3-433a-43cf-b46e-dd242585e79a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "80eb01bf-f122-48c5-a919-6098604ae58d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-05T15:44:34.2621234+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": "f57ae7c6-5abc-4261-a266-74e4fdd62330",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-05T15:44:34.2621234+00:00"
}