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": "611ba8ba-2ffe-4230-bee6-7b73ebc48a11",
"jobs_id": "32cfd319-6eed-4516-8537-30c25a0a55b4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9e02e5ca-b2a3-4c56-8c75-2272c52387ab",
"_parent_id": "c45ece71-71ab-4bcb-8e51-f52b5b6abeaf",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dd663315-6fad-4a5b-b583-c7d738748ece",
"project_reference_back_office": "sample string 5",
"project": {
"id": "580d02dc-9867-4a2b-8b64-4a87848801f0",
"_parent_id": "02e26168-b9e8-4be9-a152-eb88760c7fc0",
"root_parent_id": "349bc35e-3537-4f31-846f-41343724b147",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0aee0de6-6d84-404a-8ff8-c4eb9e734528",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "aec8da7b-5310-404a-b847-532c9bb87562",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0ee2d987-0599-4d86-a072-3fa0e29ae561",
"_parent_code": "sample string 6",
"sales_organization_id": "a2e087eb-6ed9-4c76-b7ba-745474ae28e6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3bfc8e72-ab45-4527-b5ac-cfe063d59bca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13181413-01a3-4fcf-8643-283cd10c2cf5",
"db_currency_id": "f9dc7373-5b7e-4df8-afd6-318a414a2347",
"db_language_id": "462b9973-0e4f-40ab-91c5-d9dec6bdb210",
"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": "2025-11-18T09:55:31.0202046+00:00"
},
"modified_dateutc": "2025-11-18T09:55:31.0202046+00:00"
},
"equipment_model_id": "0435e137-cf6b-4f36-a6d9-702d8a303e2e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1fc8a5a7-3fb3-4df5-aec0-63bbe57ab280",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f82e7d4f-6501-448d-abeb-bc0719753d21",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "764b0802-2582-411b-b1be-a6f4773c06eb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "70070ef1-c281-4683-9d9c-1a85bf6583ba",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3bfc8e72-ab45-4527-b5ac-cfe063d59bca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13181413-01a3-4fcf-8643-283cd10c2cf5",
"db_currency_id": "f9dc7373-5b7e-4df8-afd6-318a414a2347",
"db_language_id": "462b9973-0e4f-40ab-91c5-d9dec6bdb210",
"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": "2025-11-18T09:55:31.0202046+00:00"
},
"modified_dateutc": "2025-11-18T09:55:31.0202046+00:00"
},
"equipment_family_id": "d9172cf4-af61-4612-9ffd-45644829cac8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "aec8da7b-5310-404a-b847-532c9bb87562",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0ee2d987-0599-4d86-a072-3fa0e29ae561",
"_parent_code": "sample string 6",
"sales_organization_id": "a2e087eb-6ed9-4c76-b7ba-745474ae28e6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3bfc8e72-ab45-4527-b5ac-cfe063d59bca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13181413-01a3-4fcf-8643-283cd10c2cf5",
"db_currency_id": "f9dc7373-5b7e-4df8-afd6-318a414a2347",
"db_language_id": "462b9973-0e4f-40ab-91c5-d9dec6bdb210",
"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": "2025-11-18T09:55:31.0202046+00:00"
},
"modified_dateutc": "2025-11-18T09:55:31.0202046+00:00"
},
"date_in_production_since": "2025-11-18T09:55:31.0202046+00:00",
"date_out_of_production_since": "2025-11-18T09:55:31.0202046+00:00",
"date_end_support": "2025-11-18T09:55:31.0202046+00:00",
"sales_organization_id": "9fecb8ea-6b0d-4145-8205-ac57493645e4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3bfc8e72-ab45-4527-b5ac-cfe063d59bca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13181413-01a3-4fcf-8643-283cd10c2cf5",
"db_currency_id": "f9dc7373-5b7e-4df8-afd6-318a414a2347",
"db_language_id": "462b9973-0e4f-40ab-91c5-d9dec6bdb210",
"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": "2025-11-18T09:55:31.0202046+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": "2025-11-18T09:55:31.0202046+00:00"
},
"project_status_id": "0e60aaee-d7e9-4689-910f-0fa744640d44",
"project_status_code": "sample string 10",
"project_status": {
"id": "58ef8dce-47a4-474a-bb66-90d0dd018aec",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1c07abd9-5a71-4680-8f5b-0829b68b2a50",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3bfc8e72-ab45-4527-b5ac-cfe063d59bca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13181413-01a3-4fcf-8643-283cd10c2cf5",
"db_currency_id": "f9dc7373-5b7e-4df8-afd6-318a414a2347",
"db_language_id": "462b9973-0e4f-40ab-91c5-d9dec6bdb210",
"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": "2025-11-18T09:55:31.0202046+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-18T09:55:31.0202046+00:00"
},
"company_id": "16a00d2b-4f81-42ef-a036-881ffa3dc35b",
"company_code": "sample string 12",
"db_address_id": "5f6ff0e8-82c4-47c8-9e76-e65ff7c15bc5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c287e529-dde3-4fa3-9a18-c7a72891f661",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d5cdaa73-bab3-4051-a1ee-66120d552490",
"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": "2025-11-18T09:55:31.0202046+00:00",
"date_create": "2025-11-18T09:55:31.0202046+00:00",
"date_update": "2025-11-18T09:55:31.0202046+00:00",
"updated_by_user_id": "d6396cae-58d2-4182-8236-53c9891b3f1d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-18T09:55:31.0202046+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": "2025-11-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-18T09:55:31.0202046+00:00",
"date_last_job": "2025-11-18T09:55:31.0202046+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-18T09:55:31.0202046+00:00",
"modified_dateutc": "2025-11-18T09:55:31.0202046+00:00",
"is_mobile_installation": true
},
"job_type_id": "56b5e29e-1559-48e4-803c-1271742c467f",
"job_type_code": "sample string 7",
"job_type": {
"id": "aa8c378a-eb38-4386-8a98-1025757eed86",
"name": "sample string 2",
"sales_organization_id": "331a0cb4-8a7c-4be9-b256-6eff48dc38f0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-18T09:55:31.0202046+00:00",
"code": "sample string 7"
},
"job_priority_id": "923e5b7e-84da-4b28-82d8-22f2da0f5dff",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "15e320b2-ac9f-43f3-a537-97c793d0cc62",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "af72c267-1c2b-4590-9d05-d514ea9145d3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3bfc8e72-ab45-4527-b5ac-cfe063d59bca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13181413-01a3-4fcf-8643-283cd10c2cf5",
"db_currency_id": "f9dc7373-5b7e-4df8-afd6-318a414a2347",
"db_language_id": "462b9973-0e4f-40ab-91c5-d9dec6bdb210",
"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": "2025-11-18T09:55:31.0202046+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-18T09:55:31.0202046+00:00"
},
"job_status_id": "c55038c7-8e24-4b2b-bb6b-2ae8d79f8d61",
"job_status_code": "sample string 11",
"db_address_id": "0e58f0f4-3d6a-47de-8375-619b45cfc07f",
"contact_id": "06263012-2665-486e-8f5c-90b6948e8461",
"requested_by_company_id": "85a17c35-de34-4be8-a187-f5d359f75ff9",
"requested_by_contact_id": "e24341da-8db6-48de-a84d-e2435c94db35",
"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": "2025-11-18T09:55:31.0202046+00:00",
"due_date": "2025-11-18T09:55:31.0202046+00:00",
"date_create": "2025-11-18T09:55:31.0202046+00:00",
"date_update": "2025-11-18T09:55:31.0202046+00:00",
"date_closed": "2025-11-18T09:55:31.0202046+00:00",
"suggested_user_id": "15bd3ad0-877b-47b0-9b79-cd898d64d3b5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7b34a975-d381-46cd-8c47-d6b37622c505",
"db_language_id": "23341bdb-3361-4dbf-8715-e367412eff51",
"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": "2025-11-18T09:55:31.0202046+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ea674e41-cbf6-4323-b4e7-7baaf6316b2a",
"sales_organization": {
"id": "3bfc8e72-ab45-4527-b5ac-cfe063d59bca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13181413-01a3-4fcf-8643-283cd10c2cf5",
"db_currency_id": "f9dc7373-5b7e-4df8-afd6-318a414a2347",
"db_language_id": "462b9973-0e4f-40ab-91c5-d9dec6bdb210",
"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": "2025-11-18T09:55:31.0202046+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5fc69da2-54a7-4728-9996-e08a02e810b2",
"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": "1c13722a-5076-4915-bbc6-dd0254b95c21",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-18T09:55:31.0202046+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "17cc3812-cee8-4644-bd5e-bed62da3866e"
},
"suggested_date_start": "2025-11-18T09:55:31.0202046+00:00",
"skill_id": "81f2d255-3798-4bea-bf0a-4ae3d1ea300f",
"skill_code": "sample string 32",
"skill": {
"id": "30fb9ab9-485c-4b3b-8c4f-0502dc6d0751",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f7f0ecd1-f673-467f-b9e3-b11b36409315",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3bfc8e72-ab45-4527-b5ac-cfe063d59bca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13181413-01a3-4fcf-8643-283cd10c2cf5",
"db_currency_id": "f9dc7373-5b7e-4df8-afd6-318a414a2347",
"db_language_id": "462b9973-0e4f-40ab-91c5-d9dec6bdb210",
"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": "2025-11-18T09:55:31.0202046+00:00"
},
"modified_dateutc": "2025-11-18T09:55:31.0202046+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7c0a2ead-f375-42e6-b11f-3bffde77b099",
"date_reported_by_company": "2025-11-18T09:55:31.0202046+00:00",
"id2": 36,
"company_id": "68e02cd6-64a4-45ff-97e5-f5c2838509e6",
"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": "9b4ccbfd-d4ad-41aa-81c7-51dce07540af",
"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": "2025-11-18T09:55:31.0202046+00:00"
},
"work_instruction_details_id": "3437bd40-03e6-427e-ae4d-00e9603d8272",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9e883ed2-5e64-43d7-99e9-30ff1294cfaa",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dfa8bea7-21a4-4e5a-a86b-4ce3f4147432",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-18T09:55:31.0202046+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": "76b6520b-148e-4604-8648-4d6510812e1e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-18T09:55:31.0514665+00:00"
}