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": "9e646058-3b78-4214-8f4e-524aabb73343",
"jobs_id": "d76fe383-e954-424f-a66f-7e6cf944b711",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "14611f90-08f7-4781-ab7f-4c72494c8a67",
"_parent_id": "d56e7ea4-0446-45d7-8863-9229fcc30c38",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "53cc0cb3-c435-43dc-b53a-605361e88577",
"project_reference_back_office": "sample string 5",
"project": {
"id": "18ca0c32-02e7-4416-9f5d-3336ef5117a2",
"_parent_id": "097b00ab-21ed-43f1-99b8-6803e6694982",
"root_parent_id": "3e5f28b9-5499-44af-8d5d-2f6f2546575b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0b395f40-c103-4f0f-897d-41f1c73dbec9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b31430b7-7de8-4433-97c7-7b645940dcb4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bc58a48f-2dc0-49a5-998a-36ad23bd5c59",
"_parent_code": "sample string 6",
"sales_organization_id": "183fd2e8-2d64-49dd-9d22-1bed06fdeb0e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "14c15a70-60de-4123-9252-5fcd9501d797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0512d8a6-2816-45b3-a4c5-f5c11f170677",
"db_currency_id": "7b49205a-f4ad-48ff-9bf7-5a965132baac",
"db_language_id": "f869ecb3-cf6d-4946-92f5-9ab821fd30db",
"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-22T01:09:14.4886398+00:00"
},
"modified_dateutc": "2026-05-22T01:09:14.4886398+00:00"
},
"equipment_model_id": "6ee9745d-f8ac-41a2-b11e-cf10993ff26c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5f662ce4-e1d3-4ee1-80fa-21c82e0cd009",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5eb4ef86-8478-41ae-a334-1ffe25a18ff7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5198fe21-ce24-4d50-ba7c-6124134b0e88",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "acba55eb-1f9d-490c-8ae6-23ebbf095718",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "14c15a70-60de-4123-9252-5fcd9501d797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0512d8a6-2816-45b3-a4c5-f5c11f170677",
"db_currency_id": "7b49205a-f4ad-48ff-9bf7-5a965132baac",
"db_language_id": "f869ecb3-cf6d-4946-92f5-9ab821fd30db",
"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-22T01:09:14.4886398+00:00"
},
"modified_dateutc": "2026-05-22T01:09:14.4886398+00:00"
},
"equipment_family_id": "bb317f20-8699-4cfc-b09e-19aab5d537e9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b31430b7-7de8-4433-97c7-7b645940dcb4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bc58a48f-2dc0-49a5-998a-36ad23bd5c59",
"_parent_code": "sample string 6",
"sales_organization_id": "183fd2e8-2d64-49dd-9d22-1bed06fdeb0e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "14c15a70-60de-4123-9252-5fcd9501d797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0512d8a6-2816-45b3-a4c5-f5c11f170677",
"db_currency_id": "7b49205a-f4ad-48ff-9bf7-5a965132baac",
"db_language_id": "f869ecb3-cf6d-4946-92f5-9ab821fd30db",
"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-22T01:09:14.4886398+00:00"
},
"modified_dateutc": "2026-05-22T01:09:14.4886398+00:00"
},
"date_in_production_since": "2026-05-22T01:09:14.4886398+00:00",
"date_out_of_production_since": "2026-05-22T01:09:14.4886398+00:00",
"date_end_support": "2026-05-22T01:09:14.4886398+00:00",
"sales_organization_id": "3b88d2f4-9d9f-4fbf-892e-57a0ea59c0bb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "14c15a70-60de-4123-9252-5fcd9501d797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0512d8a6-2816-45b3-a4c5-f5c11f170677",
"db_currency_id": "7b49205a-f4ad-48ff-9bf7-5a965132baac",
"db_language_id": "f869ecb3-cf6d-4946-92f5-9ab821fd30db",
"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-22T01:09:14.4886398+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-22T01:09:14.4886398+00:00"
},
"project_status_id": "3779f094-99db-4e44-966b-97f6a9979a83",
"project_status_code": "sample string 10",
"project_status": {
"id": "78ab9f41-f9ae-45ec-bf6c-362ec0b13c53",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7491bfe4-499f-4b89-ab7c-aeae7bb0c4d1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "14c15a70-60de-4123-9252-5fcd9501d797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0512d8a6-2816-45b3-a4c5-f5c11f170677",
"db_currency_id": "7b49205a-f4ad-48ff-9bf7-5a965132baac",
"db_language_id": "f869ecb3-cf6d-4946-92f5-9ab821fd30db",
"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-22T01:09:14.4886398+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-22T01:09:14.4886398+00:00"
},
"company_id": "dc4ac3ee-b66d-4702-9a4a-061a85fe88ce",
"company_code": "sample string 12",
"db_address_id": "3393827d-138e-4a7e-bfa7-3fe034f9f42a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "58ea7c13-b8b9-45b7-855a-4110d601c065",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c971ff43-7631-4497-a379-127498ee7fcb",
"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-22T01:09:14.4886398+00:00",
"date_create": "2026-05-22T01:09:14.4886398+00:00",
"date_update": "2026-05-22T01:09:14.4886398+00:00",
"updated_by_user_id": "6ca3e1a4-dafa-403e-81e0-b9d94d3db899",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-22T01:09:14.4886398+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-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-22T01:09:14.4886398+00:00",
"date_last_job": "2026-05-22T01:09:14.4886398+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-22T01:09:14.4886398+00:00",
"modified_dateutc": "2026-05-22T01:09:14.4886398+00:00",
"is_mobile_installation": true
},
"job_type_id": "b8185a67-faea-4dbe-9205-ee5f0da3f149",
"job_type_code": "sample string 7",
"job_type": {
"id": "7b9d48ec-0da3-47bb-aba4-776e89d3c2d5",
"name": "sample string 2",
"sales_organization_id": "b0d28885-4a36-4595-85ae-0fcb76f9a4f3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-22T01:09:14.4886398+00:00",
"code": "sample string 7"
},
"job_priority_id": "b0caddbe-b9d6-4604-8999-daf2cfb99b10",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e5f4304e-5a71-4902-9fb7-c9363308360b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1ba077ee-6d52-42d9-8f84-d0b46507503c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "14c15a70-60de-4123-9252-5fcd9501d797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0512d8a6-2816-45b3-a4c5-f5c11f170677",
"db_currency_id": "7b49205a-f4ad-48ff-9bf7-5a965132baac",
"db_language_id": "f869ecb3-cf6d-4946-92f5-9ab821fd30db",
"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-22T01:09:14.4886398+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-22T01:09:14.4886398+00:00"
},
"job_status_id": "1c14684e-18ff-46ab-946d-a68c463167a3",
"job_status_code": "sample string 11",
"db_address_id": "d50c0641-c530-4806-9fe7-7a61437295f9",
"contact_id": "cb6d33f0-c334-41e0-b76c-660b03c62f16",
"requested_by_company_id": "eae6d796-e3cc-49ee-aaab-3886d151f979",
"requested_by_contact_id": "c77b5084-d330-4675-8662-ee073f0d55c5",
"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-22T01:09:14.4886398+00:00",
"due_date": "2026-05-22T01:09:14.4886398+00:00",
"date_create": "2026-05-22T01:09:14.4886398+00:00",
"date_update": "2026-05-22T01:09:14.4886398+00:00",
"date_closed": "2026-05-22T01:09:14.4886398+00:00",
"suggested_user_id": "add7b356-9753-4356-bd57-8a41e7cde624",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2246e29c-e8d9-4044-bde1-dee27489294d",
"db_language_id": "ff2aacc1-d673-429c-81c6-2698b42be468",
"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-22T01:09:14.4886398+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9a11cd3f-fa19-4cce-b510-87114a794612",
"sales_organization": {
"id": "14c15a70-60de-4123-9252-5fcd9501d797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0512d8a6-2816-45b3-a4c5-f5c11f170677",
"db_currency_id": "7b49205a-f4ad-48ff-9bf7-5a965132baac",
"db_language_id": "f869ecb3-cf6d-4946-92f5-9ab821fd30db",
"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-22T01:09:14.4886398+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "38cb7b95-ca3c-49de-adc8-ce1f0797aef9",
"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": "d41b5a09-40e3-48e4-8f55-3fe3b79b00d6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-22T01:09:14.4886398+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fdee7b64-3e54-469c-a0fc-edb568ac6fff"
},
"suggested_date_start": "2026-05-22T01:09:14.4886398+00:00",
"skill_id": "12b52c4f-39c7-42f7-a459-01fd1275c7c4",
"skill_code": "sample string 32",
"skill": {
"id": "9b411ff4-5939-415c-a685-eb336a50a21e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "db82f090-b7ff-42a5-b324-faba0c07498e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "14c15a70-60de-4123-9252-5fcd9501d797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0512d8a6-2816-45b3-a4c5-f5c11f170677",
"db_currency_id": "7b49205a-f4ad-48ff-9bf7-5a965132baac",
"db_language_id": "f869ecb3-cf6d-4946-92f5-9ab821fd30db",
"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-22T01:09:14.4886398+00:00"
},
"modified_dateutc": "2026-05-22T01:09:14.4886398+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f1f5e83d-0446-4723-a8af-08612e77bd77",
"date_reported_by_company": "2026-05-22T01:09:14.4886398+00:00",
"id2": 36,
"company_id": "239356f0-7cdd-4906-8fb6-369cf5bb3e32",
"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": "424fe517-1ccc-418a-ba46-8373e41c88cb",
"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-22T01:09:14.4886398+00:00"
},
"work_instruction_details_id": "8e5d99c6-4879-46b3-b016-0d79f3416d32",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dbee5830-9a8c-41be-8dfd-d8e92eacc309",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "932bd818-4b8a-4a25-8cc9-44ad208b2938",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-22T01:09:14.4886398+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": "49fd4d19-057a-4cd7-b0fa-883c0532d47b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-22T01:09:14.4886398+00:00"
}