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": "363a65e7-37ae-41b8-884d-d3a46a89477c",
"jobs_id": "9e71f1ea-abb0-4219-b0ca-a49c5a414e08",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a265ff19-fc1e-47df-8926-74dd8ef42d44",
"_parent_id": "dcabb126-6437-4e6f-bda8-47435aba845f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c12484a7-640b-4df2-b9a3-bb2d993ec37f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fee06b48-0370-4448-bd8c-9c9103f40273",
"_parent_id": "af139e45-abda-4328-ab1b-094a0a49c920",
"root_parent_id": "ad5260a2-7a2a-4728-889f-c9ec6927cd1f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5316b725-9d0e-4e62-b6ad-278fd9f82045",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "81778f48-20b4-4a00-86c6-7bbb38402fd7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5775db95-a351-4e57-b6f2-60ee699256fc",
"_parent_code": "sample string 6",
"sales_organization_id": "e549f5b8-7468-4a94-ba1a-da416f12b64d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dde07723-b0dd-4acb-824e-9016c06a8dcd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65415e17-3dd0-4ec4-84dd-b9b62c0886e1",
"db_currency_id": "f2447eca-44a4-453f-be20-f038a844a534",
"db_language_id": "fdcf5199-bd06-42a8-ab9e-deeb8941f3df",
"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-05-04T11:55:06.1734613+00:00"
},
"modified_dateutc": "2026-05-04T11:55:06.1734613+00:00"
},
"equipment_model_id": "7eb0677a-2a15-4789-a4cb-c64431df8335",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "773f083d-a93d-4ef4-8400-4f2d5b3e35bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "73805216-e3bb-4774-a21f-bc09b57e42ec",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8218cfe4-53d5-4802-895c-8caa15f749a5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a4ea6eed-61e5-4f6c-badc-ef548722cde9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dde07723-b0dd-4acb-824e-9016c06a8dcd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65415e17-3dd0-4ec4-84dd-b9b62c0886e1",
"db_currency_id": "f2447eca-44a4-453f-be20-f038a844a534",
"db_language_id": "fdcf5199-bd06-42a8-ab9e-deeb8941f3df",
"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-05-04T11:55:06.1734613+00:00"
},
"modified_dateutc": "2026-05-04T11:55:06.1734613+00:00"
},
"equipment_family_id": "ec3f5bd0-7ba8-452c-aec3-6411c9ec3051",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "81778f48-20b4-4a00-86c6-7bbb38402fd7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5775db95-a351-4e57-b6f2-60ee699256fc",
"_parent_code": "sample string 6",
"sales_organization_id": "e549f5b8-7468-4a94-ba1a-da416f12b64d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dde07723-b0dd-4acb-824e-9016c06a8dcd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65415e17-3dd0-4ec4-84dd-b9b62c0886e1",
"db_currency_id": "f2447eca-44a4-453f-be20-f038a844a534",
"db_language_id": "fdcf5199-bd06-42a8-ab9e-deeb8941f3df",
"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-05-04T11:55:06.1734613+00:00"
},
"modified_dateutc": "2026-05-04T11:55:06.1734613+00:00"
},
"date_in_production_since": "2026-05-04T11:55:06.1734613+00:00",
"date_out_of_production_since": "2026-05-04T11:55:06.1734613+00:00",
"date_end_support": "2026-05-04T11:55:06.1734613+00:00",
"sales_organization_id": "c9b0775a-9b96-41eb-a36d-cca6aa070488",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "dde07723-b0dd-4acb-824e-9016c06a8dcd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65415e17-3dd0-4ec4-84dd-b9b62c0886e1",
"db_currency_id": "f2447eca-44a4-453f-be20-f038a844a534",
"db_language_id": "fdcf5199-bd06-42a8-ab9e-deeb8941f3df",
"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-05-04T11:55:06.1734613+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-05-04T11:55:06.189077+00:00"
},
"project_status_id": "baab0cf3-19b0-4d3e-8ab4-6c3a51efbc2a",
"project_status_code": "sample string 10",
"project_status": {
"id": "0bedb504-77dc-470c-9a10-26295a55e727",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d3fcb89c-ac70-4e77-ac6d-06d2e88a7515",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dde07723-b0dd-4acb-824e-9016c06a8dcd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65415e17-3dd0-4ec4-84dd-b9b62c0886e1",
"db_currency_id": "f2447eca-44a4-453f-be20-f038a844a534",
"db_language_id": "fdcf5199-bd06-42a8-ab9e-deeb8941f3df",
"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-05-04T11:55:06.1734613+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-04T11:55:06.189077+00:00"
},
"company_id": "2ac6a184-833a-43a6-aa0b-b5085c5fc8fe",
"company_code": "sample string 12",
"db_address_id": "b1a72c1e-2311-4ffa-bde4-3890590cded3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7a1bc73e-aefd-4338-b8a5-d7419fdef0d3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ca8e046c-449c-48b9-a56a-4f77d0328d70",
"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-05-04T11:55:06.189077+00:00",
"date_create": "2026-05-04T11:55:06.189077+00:00",
"date_update": "2026-05-04T11:55:06.189077+00:00",
"updated_by_user_id": "13d75a94-3673-488c-8bfc-a46bd539e216",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-04T11:55:06.189077+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-05-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-04T11:55:06.189077+00:00",
"date_last_job": "2026-05-04T11:55:06.189077+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-04T11:55:06.189077+00:00",
"modified_dateutc": "2026-05-04T11:55:06.189077+00:00",
"is_mobile_installation": true
},
"job_type_id": "a2eb1ff1-f01c-4ff2-bae2-0fdc23e7beb9",
"job_type_code": "sample string 7",
"job_type": {
"id": "b6a2d15a-1020-4069-ad2c-295593903324",
"name": "sample string 2",
"sales_organization_id": "0b1e05d5-758d-4122-ba89-44a52e136c3e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-04T11:55:06.189077+00:00",
"code": "sample string 7"
},
"job_priority_id": "6cc315ca-bb0e-41f4-94cb-16abe1e29f66",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "04c3f357-67dd-4407-927d-35a70b01b6b1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "90f2a6fd-01e4-46bd-a7d7-10c874edf3b4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dde07723-b0dd-4acb-824e-9016c06a8dcd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65415e17-3dd0-4ec4-84dd-b9b62c0886e1",
"db_currency_id": "f2447eca-44a4-453f-be20-f038a844a534",
"db_language_id": "fdcf5199-bd06-42a8-ab9e-deeb8941f3df",
"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-05-04T11:55:06.1734613+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-04T11:55:06.189077+00:00"
},
"job_status_id": "e51886c3-79df-4ad6-8b41-a60ae722091c",
"job_status_code": "sample string 11",
"db_address_id": "307fabac-0145-4ef1-9a4e-d9afdac2a28e",
"contact_id": "297e6aa3-505d-4250-91ab-b45002361ca3",
"requested_by_company_id": "1a8164bd-e718-4beb-b1e0-9ab4ad0f0815",
"requested_by_contact_id": "f8c36c89-5b25-491a-83a7-fbfddbbd2912",
"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-05-04T11:55:06.189077+00:00",
"due_date": "2026-05-04T11:55:06.189077+00:00",
"date_create": "2026-05-04T11:55:06.189077+00:00",
"date_update": "2026-05-04T11:55:06.189077+00:00",
"date_closed": "2026-05-04T11:55:06.189077+00:00",
"suggested_user_id": "1056ea6e-23bd-4e6d-a97c-791fe12eea50",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2649d75a-8610-4642-806b-7be338b315b4",
"db_language_id": "ad956ee4-0194-4b6e-a3c5-56e56cfb17f4",
"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-05-04T11:55:06.189077+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8185eb19-77bb-4501-8c5e-39c7d708e201",
"sales_organization": {
"id": "dde07723-b0dd-4acb-824e-9016c06a8dcd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65415e17-3dd0-4ec4-84dd-b9b62c0886e1",
"db_currency_id": "f2447eca-44a4-453f-be20-f038a844a534",
"db_language_id": "fdcf5199-bd06-42a8-ab9e-deeb8941f3df",
"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-05-04T11:55:06.1734613+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ffe6275b-7483-466e-8c36-76afdf3ec40e",
"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": "9e86e650-dd32-40c8-b112-3fffec4ecded",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-04T11:55:06.189077+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2e25c5da-cb26-42b1-a187-3b5a00d61f47"
},
"suggested_date_start": "2026-05-04T11:55:06.189077+00:00",
"skill_id": "dd3d1341-1aff-444d-8284-c6cfe92acdcd",
"skill_code": "sample string 32",
"skill": {
"id": "e3ccc95a-c50b-466e-91bc-88461cc144b7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9d5c5986-cedc-470a-8b8f-6c4e80ea33d8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dde07723-b0dd-4acb-824e-9016c06a8dcd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65415e17-3dd0-4ec4-84dd-b9b62c0886e1",
"db_currency_id": "f2447eca-44a4-453f-be20-f038a844a534",
"db_language_id": "fdcf5199-bd06-42a8-ab9e-deeb8941f3df",
"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-05-04T11:55:06.1734613+00:00"
},
"modified_dateutc": "2026-05-04T11:55:06.189077+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0edf06e5-1e62-451b-b4ce-3686d60c4cce",
"date_reported_by_company": "2026-05-04T11:55:06.189077+00:00",
"id2": 36,
"company_id": "ab546d7d-feb9-4107-ac37-06c458662c65",
"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": "aa2a4412-ac82-4db6-a514-2e329de497a8",
"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-05-04T11:55:06.189077+00:00"
},
"work_instruction_details_id": "356e5aa9-a8b4-41e3-8ac7-d9d9b00fdbcf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0d11ce82-d5de-49f3-96d1-123a71731154",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f3963403-0844-407c-b8aa-1c168999725e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-04T11:55:06.189077+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": "b5f88a3c-6e3f-4515-9b0e-7981540026c8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-04T11:55:06.189077+00:00"
}