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": "6d4b2c89-a6f8-4648-b707-d70202e3efe3",
"jobs_id": "73e1a344-433c-4879-965f-49b5653ad5db",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5dc10e54-edc8-442a-aa2e-1fd75446a9d4",
"_parent_id": "d265b2c9-d979-427d-ba38-1488620761b6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1ba85a15-07cd-4907-b30e-d10eeb794688",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7d01d436-29e1-4c93-9f15-a92c2cf1e5f8",
"_parent_id": "3c30a003-a857-4706-93e8-b9cbcfc94cbd",
"root_parent_id": "ae926342-3c94-42ef-be34-d24f308dbf98",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7e29d065-735a-4aeb-b7f4-4fb3ff2f60f4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "38ab7a24-91ae-4c92-a6d0-fdd53f92b166",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "87d8cdde-fb55-4f36-bf26-60956138cba4",
"_parent_code": "sample string 6",
"sales_organization_id": "9188f926-aca9-4a38-8b3a-8af0d6ef1642",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ac0bb8c3-3e69-495c-a4db-d904e1bc669a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bc4e573-0f0b-4d91-b54a-9b2f82c6f598",
"db_currency_id": "5258d659-d692-468c-8e89-38e03df2fc52",
"db_language_id": "b37a2c35-77b4-4fc2-a4a3-4f3e1cb2a50f",
"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-06-09T15:49:00.5718219+00:00"
},
"modified_dateutc": "2026-06-09T15:49:00.5718219+00:00"
},
"equipment_model_id": "6a8d3b9d-bef9-469a-9164-ea892447fac1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "61276239-9d4c-4c46-9ccd-726f562c73c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a8e5b584-5025-4f98-a551-73e514983afd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b2875f94-3234-441b-ad0a-6ecb2f995671",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "239ac098-3529-45c7-ab18-f4fefe754123",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ac0bb8c3-3e69-495c-a4db-d904e1bc669a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bc4e573-0f0b-4d91-b54a-9b2f82c6f598",
"db_currency_id": "5258d659-d692-468c-8e89-38e03df2fc52",
"db_language_id": "b37a2c35-77b4-4fc2-a4a3-4f3e1cb2a50f",
"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-06-09T15:49:00.5718219+00:00"
},
"modified_dateutc": "2026-06-09T15:49:00.5718219+00:00"
},
"equipment_family_id": "b9271efd-bb50-4105-90e7-d5187c0a2d2c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "38ab7a24-91ae-4c92-a6d0-fdd53f92b166",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "87d8cdde-fb55-4f36-bf26-60956138cba4",
"_parent_code": "sample string 6",
"sales_organization_id": "9188f926-aca9-4a38-8b3a-8af0d6ef1642",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ac0bb8c3-3e69-495c-a4db-d904e1bc669a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bc4e573-0f0b-4d91-b54a-9b2f82c6f598",
"db_currency_id": "5258d659-d692-468c-8e89-38e03df2fc52",
"db_language_id": "b37a2c35-77b4-4fc2-a4a3-4f3e1cb2a50f",
"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-06-09T15:49:00.5718219+00:00"
},
"modified_dateutc": "2026-06-09T15:49:00.5718219+00:00"
},
"date_in_production_since": "2026-06-09T15:49:00.5718219+00:00",
"date_out_of_production_since": "2026-06-09T15:49:00.5718219+00:00",
"date_end_support": "2026-06-09T15:49:00.5718219+00:00",
"sales_organization_id": "b47513b9-81ac-40c1-9ddf-c8f9ef3479a3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ac0bb8c3-3e69-495c-a4db-d904e1bc669a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bc4e573-0f0b-4d91-b54a-9b2f82c6f598",
"db_currency_id": "5258d659-d692-468c-8e89-38e03df2fc52",
"db_language_id": "b37a2c35-77b4-4fc2-a4a3-4f3e1cb2a50f",
"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-06-09T15:49:00.5718219+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-06-09T15:49:00.5718219+00:00"
},
"project_status_id": "475341e1-56ce-4d5f-afbb-a84468c54ff6",
"project_status_code": "sample string 10",
"project_status": {
"id": "3a953a88-23a4-4d77-877c-ee6d207b4c71",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "43dffdab-5867-48b9-bb53-ad26f2b32235",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac0bb8c3-3e69-495c-a4db-d904e1bc669a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bc4e573-0f0b-4d91-b54a-9b2f82c6f598",
"db_currency_id": "5258d659-d692-468c-8e89-38e03df2fc52",
"db_language_id": "b37a2c35-77b4-4fc2-a4a3-4f3e1cb2a50f",
"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-06-09T15:49:00.5718219+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-09T15:49:00.5718219+00:00"
},
"company_id": "84a146ff-1570-4fed-ae9f-72243147172b",
"company_code": "sample string 12",
"db_address_id": "aeb178c8-fafd-4230-8154-21151606ef29",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3c459c41-2e7e-487a-ac78-a54af3502bad",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1a4ec25b-4e65-4d65-9872-b32078f2ea69",
"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-06-09T15:49:00.5718219+00:00",
"date_create": "2026-06-09T15:49:00.5718219+00:00",
"date_update": "2026-06-09T15:49:00.5718219+00:00",
"updated_by_user_id": "770bd9ec-1f90-4cef-a09d-93538a8a11dd",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-09T15:49:00.5718219+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-06-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-09T15:49:00.5718219+00:00",
"date_last_job": "2026-06-09T15:49:00.5718219+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-09T15:49:00.5718219+00:00",
"modified_dateutc": "2026-06-09T15:49:00.5718219+00:00",
"is_mobile_installation": true
},
"job_type_id": "a9925cf5-729f-4ba6-8ce3-d80a68a7493d",
"job_type_code": "sample string 7",
"job_type": {
"id": "26d0d623-0338-4642-be46-47787f14cddd",
"name": "sample string 2",
"sales_organization_id": "09b66dbe-6027-4919-ba9f-eb31a8ddac9f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-09T15:49:00.5718219+00:00",
"code": "sample string 7"
},
"job_priority_id": "aa6cab89-ace1-439a-8c7e-c4000c51e857",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "25ac3990-0abf-460d-928d-f9b0ad88925e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "10eb25ad-61dd-4fea-8407-d9654eaf11d8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac0bb8c3-3e69-495c-a4db-d904e1bc669a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bc4e573-0f0b-4d91-b54a-9b2f82c6f598",
"db_currency_id": "5258d659-d692-468c-8e89-38e03df2fc52",
"db_language_id": "b37a2c35-77b4-4fc2-a4a3-4f3e1cb2a50f",
"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-06-09T15:49:00.5718219+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-09T15:49:00.5718219+00:00"
},
"job_status_id": "ec274067-c242-4e07-a24f-cee09bdca855",
"job_status_code": "sample string 11",
"db_address_id": "4b1cbc6c-844d-43f9-b7f3-f5ccb69d9ddc",
"contact_id": "df7ab6ac-273a-4430-81ee-e287c9d6cc59",
"requested_by_company_id": "cc4bc143-1325-45ad-8491-434456b55d89",
"requested_by_contact_id": "35b88a35-e619-4e15-9210-2aeca5c6d1d9",
"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-06-09T15:49:00.5718219+00:00",
"due_date": "2026-06-09T15:49:00.5718219+00:00",
"date_create": "2026-06-09T15:49:00.5718219+00:00",
"date_update": "2026-06-09T15:49:00.5718219+00:00",
"date_closed": "2026-06-09T15:49:00.5718219+00:00",
"suggested_user_id": "1a09a7af-5db1-4cdd-ae9e-839e7273cf95",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5b9a3bed-e35b-4129-8825-14167d731350",
"db_language_id": "91386866-132a-4d18-958d-377a42fdf74a",
"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-06-09T15:49:00.5718219+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "61f977c5-ecdc-4faa-8c34-ae75d2940a60",
"sales_organization": {
"id": "ac0bb8c3-3e69-495c-a4db-d904e1bc669a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bc4e573-0f0b-4d91-b54a-9b2f82c6f598",
"db_currency_id": "5258d659-d692-468c-8e89-38e03df2fc52",
"db_language_id": "b37a2c35-77b4-4fc2-a4a3-4f3e1cb2a50f",
"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-06-09T15:49:00.5718219+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "459db488-ff21-4df4-9912-f91cfb787aff",
"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": "a23fea33-dccf-4fac-943c-3f9a489fa7e9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-09T15:49:00.5718219+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d0a4251c-6d5c-4c65-beb2-bacdf5d002cc"
},
"suggested_date_start": "2026-06-09T15:49:00.5718219+00:00",
"skill_id": "67b18127-851c-47de-ac41-5b0a6d44433f",
"skill_code": "sample string 32",
"skill": {
"id": "24eb3285-ea0b-480d-aba8-51605bba16d6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ad08f75b-a0c4-45dd-a4a0-d765b523eaee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac0bb8c3-3e69-495c-a4db-d904e1bc669a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bc4e573-0f0b-4d91-b54a-9b2f82c6f598",
"db_currency_id": "5258d659-d692-468c-8e89-38e03df2fc52",
"db_language_id": "b37a2c35-77b4-4fc2-a4a3-4f3e1cb2a50f",
"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-06-09T15:49:00.5718219+00:00"
},
"modified_dateutc": "2026-06-09T15:49:00.5718219+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7afb0071-3aa5-4d46-abc0-62d2d38d1028",
"date_reported_by_company": "2026-06-09T15:49:00.5718219+00:00",
"id2": 36,
"company_id": "2e5ecdb2-13e8-4e8b-9438-93637991eb08",
"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": "8d24ed23-bae0-4f84-ab66-42d29e367649",
"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-06-09T15:49:00.5718219+00:00"
},
"work_instruction_details_id": "67362fe7-a735-4fb7-95e3-40519b71b2bf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8c7f62e8-cd95-485f-8945-6dde5e992bfe",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ade9081b-8928-4922-9887-446fafc0bffd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-09T15:49:00.5874406+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": "43886e35-679b-4e20-b1d0-1ccbf559366a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-09T15:49:00.5874406+00:00"
}