Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
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": "9e64c392-660a-44f4-95c6-0147b70d15d7",
"jobs_id": "9eae03fd-69c7-40b2-a3a5-829bbd16dfe4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "90b70412-2f1e-435f-bff1-c28ae40afbee",
"_parent_id": "644f4602-e229-4626-99ea-d9368afe0a68",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8fef92c2-584b-4e05-aea5-47798b6f7ac0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2c64b425-97b4-4997-95b9-cccf6ef17fc8",
"_parent_id": "71e4c6f4-278a-409f-b78a-c3b48a8c7700",
"root_parent_id": "7c500a57-631f-464d-9343-410f81e605e7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "37ff2332-9d1c-40fa-8f7e-c530565e1569",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "58d89495-19f3-4a01-ba6a-f96b05833a0d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7d90d6f1-81dd-4783-a023-320d4bc2c78a",
"_parent_code": "sample string 6",
"sales_organization_id": "75faa169-88e5-49cf-bd8e-171daa3c0da3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a74cc529-4943-4225-b7e0-806ad2658a95",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89db7ff5-de15-4083-9b9e-7bdb333ec9a7",
"db_currency_id": "bd1e429f-d3eb-4a09-9c2e-1782ab95c3b2",
"db_language_id": "b3ba10cf-4349-4c97-8161-03545167d305",
"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-22T10:54:50.3602326+00:00"
},
"modified_dateutc": "2025-11-22T10:54:50.3602326+00:00"
},
"equipment_model_id": "bb262db9-6ae1-421c-a3e6-8c147f5396b6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1f16af02-5119-4328-9952-fa426a0bffe9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "afdad6a3-92fe-46d5-aeff-b1553b057db0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "68efe4f1-4104-4a75-89fe-b415fa1f67aa",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fdbf4702-4b18-4ea8-b4ab-a752f2b37860",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a74cc529-4943-4225-b7e0-806ad2658a95",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89db7ff5-de15-4083-9b9e-7bdb333ec9a7",
"db_currency_id": "bd1e429f-d3eb-4a09-9c2e-1782ab95c3b2",
"db_language_id": "b3ba10cf-4349-4c97-8161-03545167d305",
"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-22T10:54:50.3602326+00:00"
},
"modified_dateutc": "2025-11-22T10:54:50.3602326+00:00"
},
"equipment_family_id": "0b876bba-d6db-482e-98ab-7d3e84c10685",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "58d89495-19f3-4a01-ba6a-f96b05833a0d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7d90d6f1-81dd-4783-a023-320d4bc2c78a",
"_parent_code": "sample string 6",
"sales_organization_id": "75faa169-88e5-49cf-bd8e-171daa3c0da3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a74cc529-4943-4225-b7e0-806ad2658a95",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89db7ff5-de15-4083-9b9e-7bdb333ec9a7",
"db_currency_id": "bd1e429f-d3eb-4a09-9c2e-1782ab95c3b2",
"db_language_id": "b3ba10cf-4349-4c97-8161-03545167d305",
"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-22T10:54:50.3602326+00:00"
},
"modified_dateutc": "2025-11-22T10:54:50.3602326+00:00"
},
"date_in_production_since": "2025-11-22T10:54:50.3602326+00:00",
"date_out_of_production_since": "2025-11-22T10:54:50.3602326+00:00",
"date_end_support": "2025-11-22T10:54:50.3602326+00:00",
"sales_organization_id": "a1e5aa0b-e037-446d-8f5b-e4a12cf5b34d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a74cc529-4943-4225-b7e0-806ad2658a95",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89db7ff5-de15-4083-9b9e-7bdb333ec9a7",
"db_currency_id": "bd1e429f-d3eb-4a09-9c2e-1782ab95c3b2",
"db_language_id": "b3ba10cf-4349-4c97-8161-03545167d305",
"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-22T10:54:50.3602326+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-22T10:54:50.3602326+00:00"
},
"project_status_id": "e2b9a68f-7310-4a2b-b8d2-e251809cb0b1",
"project_status_code": "sample string 10",
"project_status": {
"id": "6b1856bd-0500-4730-858d-59436400dc22",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6a9439d6-2fd2-4bec-b9c0-dc095faf03b9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a74cc529-4943-4225-b7e0-806ad2658a95",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89db7ff5-de15-4083-9b9e-7bdb333ec9a7",
"db_currency_id": "bd1e429f-d3eb-4a09-9c2e-1782ab95c3b2",
"db_language_id": "b3ba10cf-4349-4c97-8161-03545167d305",
"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-22T10:54:50.3602326+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-22T10:54:50.3602326+00:00"
},
"company_id": "0b551e38-9ee9-4fb5-a603-02186af95325",
"company_code": "sample string 12",
"db_address_id": "c161af81-79eb-4721-9ffa-f3d54b001df6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b3e8d282-3c7e-45f2-a05c-fafd485b3b5e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4c92f5de-2941-40c1-9d12-0282b19d6f66",
"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-22T10:54:50.3602326+00:00",
"date_create": "2025-11-22T10:54:50.3602326+00:00",
"date_update": "2025-11-22T10:54:50.3602326+00:00",
"updated_by_user_id": "0055bf7b-a525-4e3a-b314-234631a54d19",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-22T10:54:50.3602326+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-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-22T10:54:50.3602326+00:00",
"date_last_job": "2025-11-22T10:54:50.3602326+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-22T10:54:50.3602326+00:00",
"modified_dateutc": "2025-11-22T10:54:50.3602326+00:00",
"is_mobile_installation": true
},
"job_type_id": "12c22232-efa0-4121-921a-33c2b5b22729",
"job_type_code": "sample string 7",
"job_type": {
"id": "a870aa89-2ab9-4e58-b801-451a96b9dbae",
"name": "sample string 2",
"sales_organization_id": "b0183a80-1d34-4d2e-ae11-18960752a1d4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-22T10:54:50.3602326+00:00",
"code": "sample string 7"
},
"job_priority_id": "6b94b219-effd-4982-882e-5f0c6e43787b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "09388e4d-d706-4cd3-95f1-65fb76ab598d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "903e12df-eb9d-4916-9e4a-90a95b5982b8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a74cc529-4943-4225-b7e0-806ad2658a95",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89db7ff5-de15-4083-9b9e-7bdb333ec9a7",
"db_currency_id": "bd1e429f-d3eb-4a09-9c2e-1782ab95c3b2",
"db_language_id": "b3ba10cf-4349-4c97-8161-03545167d305",
"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-22T10:54:50.3602326+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-22T10:54:50.3602326+00:00"
},
"job_status_id": "871b29d7-2741-47e8-b115-cd852c8d6589",
"job_status_code": "sample string 11",
"db_address_id": "218f11fc-cdf2-40e6-97e2-f89baff1ebe6",
"contact_id": "f0026f26-52f6-4eb0-b4bb-694028efd33c",
"requested_by_company_id": "f238a624-fec4-4b6c-a9a1-7283889263ec",
"requested_by_contact_id": "00113781-d3e7-478d-8516-74146c85ea02",
"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-22T10:54:50.3602326+00:00",
"due_date": "2025-11-22T10:54:50.3602326+00:00",
"date_create": "2025-11-22T10:54:50.3602326+00:00",
"date_update": "2025-11-22T10:54:50.3602326+00:00",
"date_closed": "2025-11-22T10:54:50.3602326+00:00",
"suggested_user_id": "9a2a687a-ab8e-4387-b753-00c1c8da57e0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "92f9eda5-be1b-4b90-ac38-cdba76781725",
"db_language_id": "077d9532-c26f-4f38-adca-e74ebfbd9483",
"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-22T10:54:50.3602326+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "975bdeff-2abe-43f7-a581-99c635dbdef6",
"sales_organization": {
"id": "a74cc529-4943-4225-b7e0-806ad2658a95",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89db7ff5-de15-4083-9b9e-7bdb333ec9a7",
"db_currency_id": "bd1e429f-d3eb-4a09-9c2e-1782ab95c3b2",
"db_language_id": "b3ba10cf-4349-4c97-8161-03545167d305",
"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-22T10:54:50.3602326+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e4314700-50df-4766-a3ce-8a13dfb9260e",
"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": "d39c6aa2-3d77-45a5-a33f-e72591667481",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-22T10:54:50.3602326+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fd983172-bb1f-43ca-b71e-c0160e9eacb8"
},
"suggested_date_start": "2025-11-22T10:54:50.3602326+00:00",
"skill_id": "6c5ee39c-c386-480f-a47f-bf9d8292aa28",
"skill_code": "sample string 32",
"skill": {
"id": "ddeff6e6-e73a-4eba-9f20-1ca769ca52a2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "af0c859d-1717-42a4-9d97-c4acedc5870c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a74cc529-4943-4225-b7e0-806ad2658a95",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89db7ff5-de15-4083-9b9e-7bdb333ec9a7",
"db_currency_id": "bd1e429f-d3eb-4a09-9c2e-1782ab95c3b2",
"db_language_id": "b3ba10cf-4349-4c97-8161-03545167d305",
"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-22T10:54:50.3602326+00:00"
},
"modified_dateutc": "2025-11-22T10:54:50.3602326+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9bd5f4cc-1afd-4ac1-b3d0-88ff25d56f5a",
"date_reported_by_company": "2025-11-22T10:54:50.3602326+00:00",
"id2": 36,
"company_id": "2b395fa5-e028-4322-9268-fa65f9c5308a",
"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": "38c16148-c562-4bb5-81ce-d8a15766d2ee",
"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-22T10:54:50.3602326+00:00"
},
"work_instruction_details_id": "5b87f8be-61b3-462a-9b13-48f1ace58bd5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "227d4167-ef7d-4a0b-9ba9-bb08bcd6c20c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cff10232-0314-41c5-a823-2e146b154b09",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-22T10:54:50.3602326+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": "ddc16c67-10a2-4477-bd7a-efc3c361b393",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-22T10:54:50.3758599+00:00"
}