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": "6d2db552-9b5d-4969-9b49-beb257fb13f6",
"jobs_id": "0d5aaa4f-4412-4e5f-a16d-a590e6f5f36f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c01c1784-8131-459a-a9b9-617280d97477",
"_parent_id": "7bff47c6-3088-4916-875f-bb78f67de359",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "51baedfb-ef77-4566-bbc4-5c39c97a9c82",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b7260e50-791e-4ed1-9521-b2bcc5fc73bd",
"_parent_id": "58439116-4ff9-4d9e-9d29-3ca0994f986d",
"root_parent_id": "e518c285-e97a-4f2d-ac3f-c6cec0c23666",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7a42ec17-15b2-4989-a00b-192f2bceeda9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "53df8499-6d08-4d3e-93a0-c5e76beb7a63",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "552f8942-9eab-430b-b82a-0e83fa0952f2",
"_parent_code": "sample string 6",
"sales_organization_id": "b4c1ab54-31ae-4370-b111-9672de431e77",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "31bbb92d-4b1b-45bb-a561-7a942603ddf0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5601b603-571f-41ce-904b-ee6952c4b146",
"db_currency_id": "1ef82b5f-513d-4bc3-ad82-4b1d4fac750b",
"db_language_id": "c2d60a6a-5d1f-43dd-acc7-d6e741628064",
"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-08-15T12:40:11.9642701+00:00"
},
"modified_dateutc": "2026-08-15T12:40:11.9642701+00:00"
},
"equipment_model_id": "76449ea4-29ab-4ceb-9546-f955d3419568",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "051a835f-c8ea-4bb2-be8a-85257f28e323",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f9c8b030-f9aa-4384-8af3-a07d43d54f00",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ccf4af92-a1ab-4072-9619-6591aeeb4f70",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "85d3f451-d90a-4aed-9c17-d7e47d4ec55b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "31bbb92d-4b1b-45bb-a561-7a942603ddf0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5601b603-571f-41ce-904b-ee6952c4b146",
"db_currency_id": "1ef82b5f-513d-4bc3-ad82-4b1d4fac750b",
"db_language_id": "c2d60a6a-5d1f-43dd-acc7-d6e741628064",
"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-08-15T12:40:11.9642701+00:00"
},
"modified_dateutc": "2026-08-15T12:40:11.9642701+00:00"
},
"equipment_family_id": "23538b17-4578-42f4-a880-2caa00a9b146",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "53df8499-6d08-4d3e-93a0-c5e76beb7a63",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "552f8942-9eab-430b-b82a-0e83fa0952f2",
"_parent_code": "sample string 6",
"sales_organization_id": "b4c1ab54-31ae-4370-b111-9672de431e77",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "31bbb92d-4b1b-45bb-a561-7a942603ddf0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5601b603-571f-41ce-904b-ee6952c4b146",
"db_currency_id": "1ef82b5f-513d-4bc3-ad82-4b1d4fac750b",
"db_language_id": "c2d60a6a-5d1f-43dd-acc7-d6e741628064",
"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-08-15T12:40:11.9642701+00:00"
},
"modified_dateutc": "2026-08-15T12:40:11.9642701+00:00"
},
"date_in_production_since": "2026-08-15T12:40:11.9642701+00:00",
"date_out_of_production_since": "2026-08-15T12:40:11.9642701+00:00",
"date_end_support": "2026-08-15T12:40:11.9642701+00:00",
"sales_organization_id": "4541c335-6f5f-44e9-bce9-a9445aaaa268",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "31bbb92d-4b1b-45bb-a561-7a942603ddf0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5601b603-571f-41ce-904b-ee6952c4b146",
"db_currency_id": "1ef82b5f-513d-4bc3-ad82-4b1d4fac750b",
"db_language_id": "c2d60a6a-5d1f-43dd-acc7-d6e741628064",
"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-08-15T12:40:11.9642701+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-08-15T12:40:11.9642701+00:00"
},
"project_status_id": "82126af4-48a3-4a3e-b4f3-b330f89bd648",
"project_status_code": "sample string 10",
"project_status": {
"id": "6e769bd5-361c-4ae1-8038-de2fc7628dc3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8cc64116-7691-4d9a-b44a-ca9cad1fbd02",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "31bbb92d-4b1b-45bb-a561-7a942603ddf0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5601b603-571f-41ce-904b-ee6952c4b146",
"db_currency_id": "1ef82b5f-513d-4bc3-ad82-4b1d4fac750b",
"db_language_id": "c2d60a6a-5d1f-43dd-acc7-d6e741628064",
"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-08-15T12:40:11.9642701+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-15T12:40:11.9642701+00:00"
},
"company_id": "1ed644e3-f524-470f-b6be-e011eb275e0f",
"company_code": "sample string 12",
"db_address_id": "9636e536-05d7-4e1c-ac31-f3c2ccc922ac",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fa067831-6a09-44ff-988f-923acb2be830",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1b862696-28e8-4e28-853b-d612995651d4",
"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-08-15T12:40:11.9642701+00:00",
"date_create": "2026-08-15T12:40:11.9642701+00:00",
"date_update": "2026-08-15T12:40:11.9642701+00:00",
"updated_by_user_id": "a1eede0e-d84f-49b0-af1b-95f0b8a498af",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-15T12:40:11.9642701+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-08-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-15T12:40:11.9642701+00:00",
"date_last_job": "2026-08-15T12:40:11.9642701+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-15T12:40:11.9642701+00:00",
"modified_dateutc": "2026-08-15T12:40:11.9642701+00:00",
"is_mobile_installation": true
},
"job_type_id": "d45f8c79-0f2a-48ca-b148-82e4bff0433d",
"job_type_code": "sample string 7",
"job_type": {
"id": "17519a33-cca0-4ad2-9236-4caffc1f1d6a",
"name": "sample string 2",
"sales_organization_id": "de897bf9-be48-40ec-8a1f-c51c45da5b31",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-15T12:40:11.9642701+00:00",
"code": "sample string 7"
},
"job_priority_id": "54f82834-3b48-4f8e-8b69-e06d3862016e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ca822726-e264-452b-99b6-263653da7e4e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f20ff123-ba24-4317-b1b7-2ace3613f5ff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "31bbb92d-4b1b-45bb-a561-7a942603ddf0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5601b603-571f-41ce-904b-ee6952c4b146",
"db_currency_id": "1ef82b5f-513d-4bc3-ad82-4b1d4fac750b",
"db_language_id": "c2d60a6a-5d1f-43dd-acc7-d6e741628064",
"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-08-15T12:40:11.9642701+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-15T12:40:11.9642701+00:00"
},
"job_status_id": "d71752f2-7e0b-4c4d-bd2c-6b1695593c5a",
"job_status_code": "sample string 11",
"db_address_id": "e53ae882-6ba7-4479-8915-a11aa6e0f53a",
"contact_id": "defc6859-5067-46fc-8611-649383fdd591",
"requested_by_company_id": "a475dc24-76e4-4838-b39c-e45663ad48dc",
"requested_by_contact_id": "2dcc9696-7238-4541-a478-c1e45add99e9",
"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-08-15T12:40:11.9642701+00:00",
"due_date": "2026-08-15T12:40:11.9642701+00:00",
"date_create": "2026-08-15T12:40:11.9642701+00:00",
"date_update": "2026-08-15T12:40:11.9642701+00:00",
"date_closed": "2026-08-15T12:40:11.9642701+00:00",
"suggested_user_id": "c967b8e5-6bc5-4f82-b66b-90d1ee05a956",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "806065cb-9262-4482-b520-a987da0b8ce4",
"db_language_id": "53af8d7e-243f-46b6-a6c3-07b87ee98540",
"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-08-15T12:40:11.9642701+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "06cdcc6a-6e9a-4264-9c69-51302f84d51c",
"sales_organization": {
"id": "31bbb92d-4b1b-45bb-a561-7a942603ddf0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5601b603-571f-41ce-904b-ee6952c4b146",
"db_currency_id": "1ef82b5f-513d-4bc3-ad82-4b1d4fac750b",
"db_language_id": "c2d60a6a-5d1f-43dd-acc7-d6e741628064",
"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-08-15T12:40:11.9642701+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6727040e-848f-4c6e-9ba8-b9e27123a535",
"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": "96e0b22d-e93a-4ce2-a377-73946e19c4e0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-15T12:40:11.9642701+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1f308737-1076-464b-afba-8e0c7e2d4a57"
},
"suggested_date_start": "2026-08-15T12:40:11.9642701+00:00",
"skill_id": "5e2d803d-ec4d-491a-88fd-01dcbf3880de",
"skill_code": "sample string 32",
"skill": {
"id": "c1adfc52-9fa5-4dcf-bae9-39f340ab9b10",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "643ff680-186d-433d-85b1-ff9f6aeecaa2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "31bbb92d-4b1b-45bb-a561-7a942603ddf0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5601b603-571f-41ce-904b-ee6952c4b146",
"db_currency_id": "1ef82b5f-513d-4bc3-ad82-4b1d4fac750b",
"db_language_id": "c2d60a6a-5d1f-43dd-acc7-d6e741628064",
"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-08-15T12:40:11.9642701+00:00"
},
"modified_dateutc": "2026-08-15T12:40:11.9642701+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "89d3aed9-7ea3-4fe8-803b-01f70c2cbc58",
"date_reported_by_company": "2026-08-15T12:40:11.9642701+00:00",
"id2": 36,
"company_id": "623decba-16e4-47ee-bd55-bf757ba49998",
"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": "7312f449-b096-46a6-9710-b6535bc1a396",
"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-08-15T12:40:11.9642701+00:00"
},
"work_instruction_details_id": "41e2c506-f2ab-4544-b78b-bb41d806f7ae",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "193937d3-d112-4d7b-a2af-16553539949c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8f8e57fc-bb7f-455d-8c6d-d641ec38207a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-15T12:40:11.9642701+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": "42b8006a-dc92-4fc0-a6f3-d2694580bd00",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-15T12:40:11.9642701+00:00"
}