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": "dc79c599-f7b6-4441-bdf6-5ebcb2a0670a",
"jobs_id": "bd410387-1004-494b-83fb-61415fab73d4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a4ef6dce-6160-43ef-b6c7-ff45f08541b7",
"_parent_id": "7b29155a-ef2a-4b29-a5a3-5acd739a0ced",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3e74e12f-e273-4bbe-a34b-9447fbb314b5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8941ad2c-4457-4b41-bc4a-aebb6278e358",
"_parent_id": "25287832-7c04-46c4-ab6c-d312913f29f8",
"root_parent_id": "0d98e3aa-a426-4be4-9cb4-868722349308",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2401bf59-1b9a-4e73-9c1b-c7251d40b123",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a6567b1b-b3e7-4ad6-a0ba-a95814a00362",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c9e9a7bd-d802-4522-bb63-3c6d55de24a3",
"_parent_code": "sample string 6",
"sales_organization_id": "a204f14e-d5c3-4361-8ac1-ba127645c94f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1fb9d74d-6da0-4d0b-bee0-7a14d69095d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6bb6fe47-ff25-43d1-9b11-f2eab3a5fcf2",
"db_currency_id": "8aeb3d7a-6846-4d06-8f79-3acb733121c0",
"db_language_id": "d72ae813-389f-4262-bc0e-240faf422644",
"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-10-13T05:02:47.5870454+00:00"
},
"modified_dateutc": "2025-10-13T05:02:47.5870454+00:00"
},
"equipment_model_id": "de8df1fd-0f93-45b9-ac29-6e6defc35a3d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fc6c6d81-a278-4244-b01a-dfa46311329e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a0705440-1104-4e81-abeb-219fb2aa26c3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "723e2096-185b-4a5c-a4c8-c45261cfd16b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "579349dd-db53-4c3b-b8ce-546bd05ecf9f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1fb9d74d-6da0-4d0b-bee0-7a14d69095d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6bb6fe47-ff25-43d1-9b11-f2eab3a5fcf2",
"db_currency_id": "8aeb3d7a-6846-4d06-8f79-3acb733121c0",
"db_language_id": "d72ae813-389f-4262-bc0e-240faf422644",
"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-10-13T05:02:47.5870454+00:00"
},
"modified_dateutc": "2025-10-13T05:02:47.5870454+00:00"
},
"equipment_family_id": "6e2792fa-976f-4e5e-a784-07d1fade2a4c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a6567b1b-b3e7-4ad6-a0ba-a95814a00362",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c9e9a7bd-d802-4522-bb63-3c6d55de24a3",
"_parent_code": "sample string 6",
"sales_organization_id": "a204f14e-d5c3-4361-8ac1-ba127645c94f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1fb9d74d-6da0-4d0b-bee0-7a14d69095d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6bb6fe47-ff25-43d1-9b11-f2eab3a5fcf2",
"db_currency_id": "8aeb3d7a-6846-4d06-8f79-3acb733121c0",
"db_language_id": "d72ae813-389f-4262-bc0e-240faf422644",
"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-10-13T05:02:47.5870454+00:00"
},
"modified_dateutc": "2025-10-13T05:02:47.5870454+00:00"
},
"date_in_production_since": "2025-10-13T05:02:47.5870454+00:00",
"date_out_of_production_since": "2025-10-13T05:02:47.5870454+00:00",
"date_end_support": "2025-10-13T05:02:47.5870454+00:00",
"sales_organization_id": "38d28340-ec38-4c28-a825-6f8c612b0f53",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1fb9d74d-6da0-4d0b-bee0-7a14d69095d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6bb6fe47-ff25-43d1-9b11-f2eab3a5fcf2",
"db_currency_id": "8aeb3d7a-6846-4d06-8f79-3acb733121c0",
"db_language_id": "d72ae813-389f-4262-bc0e-240faf422644",
"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-10-13T05:02:47.5870454+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-10-13T05:02:47.5870454+00:00"
},
"project_status_id": "23954b9b-47d4-4ff7-a798-61324598ee8e",
"project_status_code": "sample string 10",
"project_status": {
"id": "d1b36a5e-22d2-4590-a6db-26cb512957d2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d18070a2-673b-44ae-8c5c-e99c2c8fc381",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1fb9d74d-6da0-4d0b-bee0-7a14d69095d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6bb6fe47-ff25-43d1-9b11-f2eab3a5fcf2",
"db_currency_id": "8aeb3d7a-6846-4d06-8f79-3acb733121c0",
"db_language_id": "d72ae813-389f-4262-bc0e-240faf422644",
"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-10-13T05:02:47.5870454+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-13T05:02:47.5870454+00:00"
},
"company_id": "b1a9796b-0418-488c-850c-1cd32c88a769",
"company_code": "sample string 12",
"db_address_id": "b796fb7f-089a-4826-a031-8335ef0ec8e3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "84f60ae2-3287-4e49-8b4b-a28456498333",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "66398f0f-3327-428e-bb62-5c68f994b3a4",
"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-10-13T05:02:47.5870454+00:00",
"date_create": "2025-10-13T05:02:47.5870454+00:00",
"date_update": "2025-10-13T05:02:47.5870454+00:00",
"updated_by_user_id": "be309a12-0e03-401b-b05a-4e4c242866f7",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-13T05:02:47.5870454+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-10-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-13T05:02:47.6026697+00:00",
"date_last_job": "2025-10-13T05:02:47.6026697+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-13T05:02:47.6026697+00:00",
"modified_dateutc": "2025-10-13T05:02:47.6026697+00:00",
"is_mobile_installation": true
},
"job_type_id": "97bde735-3162-4d4a-ba71-c7851d287f74",
"job_type_code": "sample string 7",
"job_type": {
"id": "7d975c5f-465a-4c62-90e1-507b8145a5c9",
"name": "sample string 2",
"sales_organization_id": "d3fa88b7-93a3-4519-806d-ef88eaaf8049",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-13T05:02:47.6026697+00:00",
"code": "sample string 7"
},
"job_priority_id": "07e34cc1-01ed-490a-a8ff-34c6ded18f1e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "16208b3b-99c2-4621-ab3b-8ac5281700e3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fee1425d-4fac-4c8d-86ab-59cae2600c9e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1fb9d74d-6da0-4d0b-bee0-7a14d69095d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6bb6fe47-ff25-43d1-9b11-f2eab3a5fcf2",
"db_currency_id": "8aeb3d7a-6846-4d06-8f79-3acb733121c0",
"db_language_id": "d72ae813-389f-4262-bc0e-240faf422644",
"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-10-13T05:02:47.5870454+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-13T05:02:47.6026697+00:00"
},
"job_status_id": "737f1e59-c96b-427f-a420-aab82fa45820",
"job_status_code": "sample string 11",
"db_address_id": "84654589-182b-42a4-9add-34eed516f4ca",
"contact_id": "05b39a31-cda3-4983-b065-739566549892",
"requested_by_company_id": "614f7a1a-70ea-447b-94f9-6b9470641e6f",
"requested_by_contact_id": "140003eb-cb15-4dd4-83b9-b2d75f334b44",
"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-10-13T05:02:47.6026697+00:00",
"due_date": "2025-10-13T05:02:47.6026697+00:00",
"date_create": "2025-10-13T05:02:47.6026697+00:00",
"date_update": "2025-10-13T05:02:47.6026697+00:00",
"date_closed": "2025-10-13T05:02:47.6026697+00:00",
"suggested_user_id": "66fe6fdb-de6c-40d6-ae56-d916a68e52b3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6f0d2d9d-dafe-43b3-a604-8dba5f385786",
"db_language_id": "69f5b0fb-0184-4a4a-882b-757d623cba14",
"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-10-13T05:02:47.6026697+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2d308d51-31d5-4fc1-b600-ed5322d0e064",
"sales_organization": {
"id": "1fb9d74d-6da0-4d0b-bee0-7a14d69095d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6bb6fe47-ff25-43d1-9b11-f2eab3a5fcf2",
"db_currency_id": "8aeb3d7a-6846-4d06-8f79-3acb733121c0",
"db_language_id": "d72ae813-389f-4262-bc0e-240faf422644",
"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-10-13T05:02:47.5870454+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "263da61b-7670-4e4a-af5a-f2f780bf4cd5",
"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": "9ac473c5-1dd1-4519-85c3-4557411e5b8b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-13T05:02:47.6026697+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8a610bf4-0c28-47a7-a060-7994098e93b6"
},
"suggested_date_start": "2025-10-13T05:02:47.6026697+00:00",
"skill_id": "615c2ebd-589f-4b75-9aa7-b827302c2fe8",
"skill_code": "sample string 32",
"skill": {
"id": "5d081bea-ce57-4e0e-b39a-c6175fb2a210",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4bd92a68-c17d-4e8a-b413-5db0fc311026",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1fb9d74d-6da0-4d0b-bee0-7a14d69095d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6bb6fe47-ff25-43d1-9b11-f2eab3a5fcf2",
"db_currency_id": "8aeb3d7a-6846-4d06-8f79-3acb733121c0",
"db_language_id": "d72ae813-389f-4262-bc0e-240faf422644",
"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-10-13T05:02:47.5870454+00:00"
},
"modified_dateutc": "2025-10-13T05:02:47.6026697+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ac9a993d-dd10-491e-ae15-b787d0fab037",
"date_reported_by_company": "2025-10-13T05:02:47.6026697+00:00",
"id2": 36,
"company_id": "e6f36785-0940-480d-b5a6-367a51ed6382",
"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": "58dc555a-8518-4ab0-b33e-a4def373099e",
"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-10-13T05:02:47.6026697+00:00"
},
"work_instruction_details_id": "f511fec0-0a5a-4710-898d-3adc528532ef",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "06bebf5c-aebf-495b-9a5d-58aae8d030b9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "724857bf-41b7-4d0d-be76-152a37800c61",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-13T05:02:47.6026697+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": "11196a89-d582-4ec6-bdbc-b36f37de73bd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-13T05:02:47.6026697+00:00"
}