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": "9b237272-9d16-42be-8a40-b26295d0192f",
"jobs_id": "965d1024-84a6-4fb3-8609-b62d6ff7f6a0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4005a9a0-64d4-4b83-bf6a-d2457190956e",
"_parent_id": "a5d6368a-022f-487b-af14-245640f96af3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d29911c9-ae31-45ec-abb1-dd9edc8a47c6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ee464b11-1e1c-4640-9cbe-a39fb2573c0a",
"_parent_id": "8c77bbc7-dbbf-400e-adea-eaf77463d82d",
"root_parent_id": "1e76e191-6298-4070-9a45-24c8106bc619",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "26b90352-0a26-4943-aed7-2560b31b2078",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "49e52d74-2e95-495b-9b37-310219f55179",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "411d284e-5a4f-4ad4-b47a-eef46e53b257",
"_parent_code": "sample string 6",
"sales_organization_id": "782c2bd6-d94f-4a99-b08f-2fca2ea00f52",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4a3dfea5-73cd-44a7-b75b-0b750e3cd6b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72192c93-840a-4190-9fbb-6bf2ffc6153f",
"db_currency_id": "ef3604f9-c6fc-4f68-bd46-9e61960b0ef0",
"db_language_id": "8d1ec4ef-c673-4dfd-8b5e-e4ac78a4f200",
"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-03-04T03:00:43.798875+00:00"
},
"modified_dateutc": "2026-03-04T03:00:43.798875+00:00"
},
"equipment_model_id": "b2da2ff5-05c1-4dff-b5ae-3542d97a03d6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "46335ac9-42cc-4612-9cae-36932411d960",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "abcf645e-db28-4673-97a1-ddbab7c678f6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2ea810cc-1f06-44f9-813b-ff4fa5f09d4f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6382753d-0861-4fae-967e-bc3c912166b3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4a3dfea5-73cd-44a7-b75b-0b750e3cd6b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72192c93-840a-4190-9fbb-6bf2ffc6153f",
"db_currency_id": "ef3604f9-c6fc-4f68-bd46-9e61960b0ef0",
"db_language_id": "8d1ec4ef-c673-4dfd-8b5e-e4ac78a4f200",
"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-03-04T03:00:43.798875+00:00"
},
"modified_dateutc": "2026-03-04T03:00:43.798875+00:00"
},
"equipment_family_id": "4a4a7066-7d69-49df-a8a1-29da876fd466",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "49e52d74-2e95-495b-9b37-310219f55179",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "411d284e-5a4f-4ad4-b47a-eef46e53b257",
"_parent_code": "sample string 6",
"sales_organization_id": "782c2bd6-d94f-4a99-b08f-2fca2ea00f52",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4a3dfea5-73cd-44a7-b75b-0b750e3cd6b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72192c93-840a-4190-9fbb-6bf2ffc6153f",
"db_currency_id": "ef3604f9-c6fc-4f68-bd46-9e61960b0ef0",
"db_language_id": "8d1ec4ef-c673-4dfd-8b5e-e4ac78a4f200",
"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-03-04T03:00:43.798875+00:00"
},
"modified_dateutc": "2026-03-04T03:00:43.798875+00:00"
},
"date_in_production_since": "2026-03-04T03:00:43.798875+00:00",
"date_out_of_production_since": "2026-03-04T03:00:43.798875+00:00",
"date_end_support": "2026-03-04T03:00:43.798875+00:00",
"sales_organization_id": "ff0dbd5f-5060-4be4-995d-2e80b0b1d0fc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4a3dfea5-73cd-44a7-b75b-0b750e3cd6b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72192c93-840a-4190-9fbb-6bf2ffc6153f",
"db_currency_id": "ef3604f9-c6fc-4f68-bd46-9e61960b0ef0",
"db_language_id": "8d1ec4ef-c673-4dfd-8b5e-e4ac78a4f200",
"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-03-04T03:00:43.798875+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-03-04T03:00:43.798875+00:00"
},
"project_status_id": "1b89bb3a-0503-40ba-b63c-0edc89acef08",
"project_status_code": "sample string 10",
"project_status": {
"id": "03319653-08e2-478b-afc4-295d283a8ced",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "04c15741-8093-46a5-81c7-acd2834ab309",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a3dfea5-73cd-44a7-b75b-0b750e3cd6b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72192c93-840a-4190-9fbb-6bf2ffc6153f",
"db_currency_id": "ef3604f9-c6fc-4f68-bd46-9e61960b0ef0",
"db_language_id": "8d1ec4ef-c673-4dfd-8b5e-e4ac78a4f200",
"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-03-04T03:00:43.798875+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-04T03:00:43.798875+00:00"
},
"company_id": "0e98be4b-01c8-4c93-8701-a232b52a1b46",
"company_code": "sample string 12",
"db_address_id": "9cb4623a-0346-498b-9129-a37e9d14ad39",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "27275447-32c0-4a7f-bbea-d589d140dbdc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "82e484ab-9f1e-4155-929a-bf34c6025d05",
"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-03-04T03:00:43.798875+00:00",
"date_create": "2026-03-04T03:00:43.798875+00:00",
"date_update": "2026-03-04T03:00:43.798875+00:00",
"updated_by_user_id": "4bc9a8a9-c35a-4ce2-8296-032c21a384c8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-04T03:00:43.798875+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-03-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-04T03:00:43.798875+00:00",
"date_last_job": "2026-03-04T03:00:43.798875+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-04T03:00:43.798875+00:00",
"modified_dateutc": "2026-03-04T03:00:43.798875+00:00",
"is_mobile_installation": true
},
"job_type_id": "1ca4f90c-f1d2-481d-9440-b0994d811908",
"job_type_code": "sample string 7",
"job_type": {
"id": "6970116e-871f-46ea-bd64-858124c573d6",
"name": "sample string 2",
"sales_organization_id": "4578075c-91d1-4971-9b06-906804e787ac",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-04T03:00:43.798875+00:00",
"code": "sample string 7"
},
"job_priority_id": "e6608ce2-fce9-4270-84d9-d1d2a1df9814",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "25fa7d7c-b1fd-41d6-8291-07c9522591ad",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4120121a-cb41-4789-935d-80fb95411197",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a3dfea5-73cd-44a7-b75b-0b750e3cd6b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72192c93-840a-4190-9fbb-6bf2ffc6153f",
"db_currency_id": "ef3604f9-c6fc-4f68-bd46-9e61960b0ef0",
"db_language_id": "8d1ec4ef-c673-4dfd-8b5e-e4ac78a4f200",
"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-03-04T03:00:43.798875+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-04T03:00:43.798875+00:00"
},
"job_status_id": "e67e85ec-3e04-41e8-84b4-ee4730d4041c",
"job_status_code": "sample string 11",
"db_address_id": "81ab2b40-02b6-4978-b864-591d5df26e14",
"contact_id": "2b38784d-4475-49ba-a5d7-389e9c870516",
"requested_by_company_id": "f281a687-43d2-44f6-816c-078574ed7b24",
"requested_by_contact_id": "b9a11fbd-0e6a-4f01-b135-ee745c645464",
"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-03-04T03:00:43.798875+00:00",
"due_date": "2026-03-04T03:00:43.798875+00:00",
"date_create": "2026-03-04T03:00:43.798875+00:00",
"date_update": "2026-03-04T03:00:43.798875+00:00",
"date_closed": "2026-03-04T03:00:43.798875+00:00",
"suggested_user_id": "7a872e48-53c2-4226-a34f-5f7cb66b6da5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "190e3c9b-f3a4-4573-871d-6d17de3b48e4",
"db_language_id": "83cbbd4d-c785-4d66-ab71-218d6f0a4ef4",
"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-03-04T03:00:43.798875+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f8730703-0f14-453b-a3cf-0bb7c42013c9",
"sales_organization": {
"id": "4a3dfea5-73cd-44a7-b75b-0b750e3cd6b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72192c93-840a-4190-9fbb-6bf2ffc6153f",
"db_currency_id": "ef3604f9-c6fc-4f68-bd46-9e61960b0ef0",
"db_language_id": "8d1ec4ef-c673-4dfd-8b5e-e4ac78a4f200",
"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-03-04T03:00:43.798875+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d3c19ef3-d422-43c0-a5c0-29ab43433a23",
"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": "41a1c92c-2129-4b49-a1c8-832685dc33ca",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-04T03:00:43.798875+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "943cc85a-a673-4f0d-af3e-07b3f2b82833"
},
"suggested_date_start": "2026-03-04T03:00:43.798875+00:00",
"skill_id": "94d0587f-987e-4325-8551-397f306d1fa6",
"skill_code": "sample string 32",
"skill": {
"id": "a89dd92f-9d29-4932-94f0-6edf005b5dd2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f777adf2-306c-4014-825a-a55727275d72",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a3dfea5-73cd-44a7-b75b-0b750e3cd6b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72192c93-840a-4190-9fbb-6bf2ffc6153f",
"db_currency_id": "ef3604f9-c6fc-4f68-bd46-9e61960b0ef0",
"db_language_id": "8d1ec4ef-c673-4dfd-8b5e-e4ac78a4f200",
"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-03-04T03:00:43.798875+00:00"
},
"modified_dateutc": "2026-03-04T03:00:43.798875+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3c0a76cc-8c32-4f28-b4f7-6192f9fe9a4d",
"date_reported_by_company": "2026-03-04T03:00:43.798875+00:00",
"id2": 36,
"company_id": "c2ffed74-5c6a-4313-badb-181a3431ab66",
"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": "2b0d056a-b977-4ecb-bb7e-4618e47e04e7",
"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-03-04T03:00:43.8145034+00:00"
},
"work_instruction_details_id": "c8f118c3-82b7-4263-9770-9c4b3da6dff3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4b05d336-742a-42ee-b014-d773a4597680",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1ffeb660-1171-431b-85cb-b1f76cc7cc6b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-04T03:00:43.8145034+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": "f67faed8-c914-4340-97c9-b18fe4f84b6a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-04T03:00:43.8145034+00:00"
}