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": "4cb6a10e-275d-4cc8-a9fe-f204c109762c",
"jobs_id": "cda79479-ba0c-46ae-981d-80e59696f64c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "afa0fc3f-269d-472c-85fb-79ba1c1454d3",
"_parent_id": "d134c93e-0af8-463a-b0b0-d003c21cdef8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "893fd9a1-4923-42ce-9b87-21af4d6fa2aa",
"project_reference_back_office": "sample string 5",
"project": {
"id": "343a5cfa-8af7-42d7-a247-4f6c6ab523c8",
"_parent_id": "e0f2f5db-4d04-4173-b48f-2d5426cfbeb3",
"root_parent_id": "37ac402c-a33a-40cf-85af-5aaa3ff43901",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e6849958-a146-409a-a43d-c59346aa9100",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f575e084-2be8-4b13-8d55-b39aa0e24b76",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "753677e2-7b4d-41fd-ac76-ea2fcce66d99",
"_parent_code": "sample string 6",
"sales_organization_id": "44474bde-78c3-4d7d-a8d8-e2b6dc3eaf8f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1b05b617-76a2-4074-a682-ea9e68c56bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5812f43e-21fa-4029-a722-b74d8a48c790",
"db_currency_id": "946b7c16-dbfc-4d58-a3d7-80ae0c335d13",
"db_language_id": "52ca025f-5062-4314-99fa-d65f8e5bde08",
"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-05-31T23:55:31.8817932+00:00"
},
"modified_dateutc": "2025-05-31T23:55:31.8817932+00:00"
},
"equipment_model_id": "b9841c2e-cf0f-4a4d-a2ef-f0e4104e4b2e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "78908c85-0d5d-4a02-886f-469021e34fdd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4adc2fd8-4057-4f3a-a1d4-28e1e3d3a078",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fd5ed2d5-d120-4cbf-9316-97c6f555e49c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c9a9eb90-7a28-4de8-bbac-5441d1452a7c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1b05b617-76a2-4074-a682-ea9e68c56bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5812f43e-21fa-4029-a722-b74d8a48c790",
"db_currency_id": "946b7c16-dbfc-4d58-a3d7-80ae0c335d13",
"db_language_id": "52ca025f-5062-4314-99fa-d65f8e5bde08",
"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-05-31T23:55:31.8817932+00:00"
},
"modified_dateutc": "2025-05-31T23:55:31.8817932+00:00"
},
"equipment_family_id": "9c446720-e0dc-41ef-9682-0af3dcb865ac",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f575e084-2be8-4b13-8d55-b39aa0e24b76",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "753677e2-7b4d-41fd-ac76-ea2fcce66d99",
"_parent_code": "sample string 6",
"sales_organization_id": "44474bde-78c3-4d7d-a8d8-e2b6dc3eaf8f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1b05b617-76a2-4074-a682-ea9e68c56bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5812f43e-21fa-4029-a722-b74d8a48c790",
"db_currency_id": "946b7c16-dbfc-4d58-a3d7-80ae0c335d13",
"db_language_id": "52ca025f-5062-4314-99fa-d65f8e5bde08",
"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-05-31T23:55:31.8817932+00:00"
},
"modified_dateutc": "2025-05-31T23:55:31.8817932+00:00"
},
"date_in_production_since": "2025-05-31T23:55:31.8817932+00:00",
"date_out_of_production_since": "2025-05-31T23:55:31.8817932+00:00",
"date_end_support": "2025-05-31T23:55:31.8817932+00:00",
"sales_organization_id": "922812b2-78ea-447f-92a2-14d9cb531856",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1b05b617-76a2-4074-a682-ea9e68c56bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5812f43e-21fa-4029-a722-b74d8a48c790",
"db_currency_id": "946b7c16-dbfc-4d58-a3d7-80ae0c335d13",
"db_language_id": "52ca025f-5062-4314-99fa-d65f8e5bde08",
"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-05-31T23:55:31.8817932+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-05-31T23:55:31.8817932+00:00"
},
"project_status_id": "13ea3c85-6fd3-42cf-91d5-3521507180cf",
"project_status_code": "sample string 10",
"project_status": {
"id": "91374be8-7261-4719-8f46-524b00a61a72",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1602c973-4b3b-4fa1-814c-0d5fe0472174",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1b05b617-76a2-4074-a682-ea9e68c56bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5812f43e-21fa-4029-a722-b74d8a48c790",
"db_currency_id": "946b7c16-dbfc-4d58-a3d7-80ae0c335d13",
"db_language_id": "52ca025f-5062-4314-99fa-d65f8e5bde08",
"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-05-31T23:55:31.8817932+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-31T23:55:31.8817932+00:00"
},
"company_id": "1d75633b-48a3-4655-859d-63e4c4b28b25",
"company_code": "sample string 12",
"db_address_id": "e33c9e4a-41de-4dd7-ab13-b19d6a8fcff8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "07186ecb-ec59-4f02-9797-81b5aaeb00bb",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9056149d-181d-478f-857c-28436a79b810",
"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-05-31T23:55:31.8817932+00:00",
"date_create": "2025-05-31T23:55:31.8817932+00:00",
"date_update": "2025-05-31T23:55:31.8817932+00:00",
"updated_by_user_id": "a51dfe3f-737d-4528-a033-e2463ddfe85d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-05-31T23:55:31.8817932+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-05-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-05-31T23:55:31.8817932+00:00",
"date_last_job": "2025-05-31T23:55:31.8817932+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-05-31T23:55:31.8817932+00:00",
"modified_dateutc": "2025-05-31T23:55:31.8817932+00:00",
"is_mobile_installation": true
},
"job_type_id": "8e00d73e-1606-4e27-a88c-3de84b037570",
"job_type_code": "sample string 7",
"job_type": {
"id": "5155342f-c256-4ce3-b463-fcf4b72559a0",
"name": "sample string 2",
"sales_organization_id": "2c3572b3-6e18-492c-a072-1854f9ad5bc0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-05-31T23:55:31.8817932+00:00",
"code": "sample string 7"
},
"job_priority_id": "5be80a04-b1c5-457c-a205-5cc5d72b8a3e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f3f06d37-a151-494c-8e8c-37c16a3d2521",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e17eec81-57b8-4d11-ba8f-03627ec2d156",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1b05b617-76a2-4074-a682-ea9e68c56bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5812f43e-21fa-4029-a722-b74d8a48c790",
"db_currency_id": "946b7c16-dbfc-4d58-a3d7-80ae0c335d13",
"db_language_id": "52ca025f-5062-4314-99fa-d65f8e5bde08",
"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-05-31T23:55:31.8817932+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-31T23:55:31.8817932+00:00"
},
"job_status_id": "9b35c219-2bc9-4c6b-a077-998fb08eb357",
"job_status_code": "sample string 11",
"db_address_id": "0c21f3bc-83b9-4e13-971a-8f733733bd4b",
"contact_id": "bc7b9be7-fc09-4017-a484-db4f1106787e",
"requested_by_company_id": "2d975a99-a83b-48c5-a79d-b05c9d3902f1",
"requested_by_contact_id": "750c1624-847a-4ebd-a3f3-ff87e76de1eb",
"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-05-31T23:55:31.8817932+00:00",
"due_date": "2025-05-31T23:55:31.8817932+00:00",
"date_create": "2025-05-31T23:55:31.8817932+00:00",
"date_update": "2025-05-31T23:55:31.8817932+00:00",
"date_closed": "2025-05-31T23:55:31.8817932+00:00",
"suggested_user_id": "5a56a35f-533f-453b-8664-bc3dc3c7dc97",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "668cf992-d0ca-4124-aeed-e4b96114e14f",
"db_language_id": "12a3b9ad-d5ca-4724-bb81-98289fef70b9",
"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-05-31T23:55:31.8817932+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a5570001-d060-4ffe-8867-2d5a7e16ca1c",
"sales_organization": {
"id": "1b05b617-76a2-4074-a682-ea9e68c56bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5812f43e-21fa-4029-a722-b74d8a48c790",
"db_currency_id": "946b7c16-dbfc-4d58-a3d7-80ae0c335d13",
"db_language_id": "52ca025f-5062-4314-99fa-d65f8e5bde08",
"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-05-31T23:55:31.8817932+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b4014c11-3c54-48c5-b563-aa7fe586489d",
"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": "9fd2345c-2455-4aca-953b-6689ce49639b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-05-31T23:55:31.8817932+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "24e7b90a-5271-4cc6-8c83-854a22974c4e"
},
"suggested_date_start": "2025-05-31T23:55:31.8817932+00:00",
"skill_id": "b19425c5-46a8-40cc-a212-c18b78d3fe81",
"skill_code": "sample string 32",
"skill": {
"id": "b8ec048e-7102-4fbf-90ce-c419b3888fce",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e3abcf82-cb39-40cb-b575-de6bd4dd4651",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1b05b617-76a2-4074-a682-ea9e68c56bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5812f43e-21fa-4029-a722-b74d8a48c790",
"db_currency_id": "946b7c16-dbfc-4d58-a3d7-80ae0c335d13",
"db_language_id": "52ca025f-5062-4314-99fa-d65f8e5bde08",
"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-05-31T23:55:31.8817932+00:00"
},
"modified_dateutc": "2025-05-31T23:55:31.8817932+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cf104ce2-325e-43b8-9408-04697ea8e45b",
"date_reported_by_company": "2025-05-31T23:55:31.8817932+00:00",
"id2": 36,
"company_id": "c12f2923-b066-4d9e-9422-d89379062622",
"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": "986bd532-2266-4022-84f9-32c7ad3ef316",
"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-05-31T23:55:31.8817932+00:00"
},
"work_instruction_details_id": "608fe5be-83e3-4ef0-b16e-1d4de65b5092",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "097add6d-0794-465b-9f09-d46b55d48594",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cc1005fb-50e9-4933-85b8-d1f68eb61418",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-05-31T23:55:31.8817932+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": "86222c94-89d2-4c84-9edd-2e57fac44e57",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-05-31T23:55:31.8817932+00:00"
}