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": "309f9527-8753-42f6-a97e-1102177bf634",
"jobs_id": "2f74d335-ce85-4560-a53f-0fd0841f168f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a1e4d0b5-fe76-46ed-b6c1-2d478ac8f82d",
"_parent_id": "b557fe33-11ae-448c-a27a-a5f66c76dcd9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6063fb80-4792-486a-adfa-2e7e484d052e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ac2150b5-24d7-4e94-bc6a-8882189c4a8e",
"_parent_id": "5ae036a0-d3d4-4ef0-9619-d25697795bc7",
"root_parent_id": "945917b6-ce7d-4f72-8ac7-07a7e332654c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "eef73078-0c6c-4431-9cbc-ba940bdbf1fe",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "511177a6-cb10-415e-ab3f-426a22ebc634",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bf6e0d36-b495-4fb7-af53-34e5ab095bbc",
"_parent_code": "sample string 6",
"sales_organization_id": "53d621cd-3501-4cfe-a447-40e53dcbcb67",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "44fa6cb5-8102-451d-bf89-1fc7f2926411",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b4a0ed5-c271-4f19-a0ec-14715d031cf0",
"db_currency_id": "006efe50-f296-479d-8617-bcc13bdbc5ed",
"db_language_id": "aad50a1c-93f4-44fd-9fbe-b49440dfdf48",
"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-09-21T02:59:27.7329384+00:00"
},
"modified_dateutc": "2026-09-21T02:59:27.7329384+00:00"
},
"equipment_model_id": "824e3c46-fa1e-4756-8440-c59a73b5897d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6e6fae0c-81fa-426c-ab91-621b3dcb7a37",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2234ba7e-61f5-4e55-b7ac-9796184ad88b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "973fa761-d9f9-45e8-be6d-296d29acd144",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "55c5095d-ec94-49c9-96ae-9bba2644f8a8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "44fa6cb5-8102-451d-bf89-1fc7f2926411",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b4a0ed5-c271-4f19-a0ec-14715d031cf0",
"db_currency_id": "006efe50-f296-479d-8617-bcc13bdbc5ed",
"db_language_id": "aad50a1c-93f4-44fd-9fbe-b49440dfdf48",
"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-09-21T02:59:27.7329384+00:00"
},
"modified_dateutc": "2026-09-21T02:59:27.7329384+00:00"
},
"equipment_family_id": "6be58b25-a0e0-4c27-b812-ccc2710529ca",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "511177a6-cb10-415e-ab3f-426a22ebc634",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bf6e0d36-b495-4fb7-af53-34e5ab095bbc",
"_parent_code": "sample string 6",
"sales_organization_id": "53d621cd-3501-4cfe-a447-40e53dcbcb67",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "44fa6cb5-8102-451d-bf89-1fc7f2926411",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b4a0ed5-c271-4f19-a0ec-14715d031cf0",
"db_currency_id": "006efe50-f296-479d-8617-bcc13bdbc5ed",
"db_language_id": "aad50a1c-93f4-44fd-9fbe-b49440dfdf48",
"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-09-21T02:59:27.7329384+00:00"
},
"modified_dateutc": "2026-09-21T02:59:27.7329384+00:00"
},
"date_in_production_since": "2026-09-21T02:59:27.7329384+00:00",
"date_out_of_production_since": "2026-09-21T02:59:27.7329384+00:00",
"date_end_support": "2026-09-21T02:59:27.7329384+00:00",
"sales_organization_id": "83cb3c72-4f3a-4fae-9b9b-f43ef5c1952c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "44fa6cb5-8102-451d-bf89-1fc7f2926411",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b4a0ed5-c271-4f19-a0ec-14715d031cf0",
"db_currency_id": "006efe50-f296-479d-8617-bcc13bdbc5ed",
"db_language_id": "aad50a1c-93f4-44fd-9fbe-b49440dfdf48",
"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-09-21T02:59:27.7329384+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-09-21T02:59:27.7329384+00:00"
},
"project_status_id": "c0bedadd-10fb-4757-8534-e95c3ba6c667",
"project_status_code": "sample string 10",
"project_status": {
"id": "782f5b9b-401b-467a-9d46-45be42c500c9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b22b3d32-b3d1-47b7-aa47-7da91c3b5857",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "44fa6cb5-8102-451d-bf89-1fc7f2926411",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b4a0ed5-c271-4f19-a0ec-14715d031cf0",
"db_currency_id": "006efe50-f296-479d-8617-bcc13bdbc5ed",
"db_language_id": "aad50a1c-93f4-44fd-9fbe-b49440dfdf48",
"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-09-21T02:59:27.7329384+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-21T02:59:27.7329384+00:00"
},
"company_id": "f58f9086-a477-427c-b278-cbb726b33b60",
"company_code": "sample string 12",
"db_address_id": "7280d708-2d2e-4719-88ed-b70be63a71d2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5b10ce32-c0c6-4c2f-976f-0c1029c40189",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8d6fabd4-ab70-4cfb-989e-6389641c6e75",
"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-09-21T02:59:27.7329384+00:00",
"date_create": "2026-09-21T02:59:27.7329384+00:00",
"date_update": "2026-09-21T02:59:27.7329384+00:00",
"updated_by_user_id": "40d52526-12a1-468e-9b77-e1e8edd4d932",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-21T02:59:27.7329384+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-09-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-21T02:59:27.7329384+00:00",
"date_last_job": "2026-09-21T02:59:27.7329384+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-21T02:59:27.7329384+00:00",
"modified_dateutc": "2026-09-21T02:59:27.7329384+00:00",
"is_mobile_installation": true
},
"job_type_id": "cb6a8bdb-3c15-417c-b7ed-6bdd69cb5504",
"job_type_code": "sample string 7",
"job_type": {
"id": "e0483b01-5350-4d1e-8bb3-a4a343df55e5",
"name": "sample string 2",
"sales_organization_id": "c6604f32-91f2-43a1-b0e7-3eff8dcd38fe",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-21T02:59:27.7329384+00:00",
"code": "sample string 7"
},
"job_priority_id": "548c71d5-593b-4cd6-b57d-fca768eaab70",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5e9b596c-2cf9-4231-a326-bd95a4933beb",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "15437133-af55-435a-a59c-874eec9376d9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "44fa6cb5-8102-451d-bf89-1fc7f2926411",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b4a0ed5-c271-4f19-a0ec-14715d031cf0",
"db_currency_id": "006efe50-f296-479d-8617-bcc13bdbc5ed",
"db_language_id": "aad50a1c-93f4-44fd-9fbe-b49440dfdf48",
"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-09-21T02:59:27.7329384+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-21T02:59:27.7329384+00:00"
},
"job_status_id": "1f2e0249-b9cb-4b94-80ba-110390e11710",
"job_status_code": "sample string 11",
"db_address_id": "a6d44af9-9ec8-4617-b711-48801ea578ff",
"contact_id": "b2205c08-ac94-436f-bfb9-49e5a95bf75e",
"requested_by_company_id": "1df43584-1ea7-4027-8909-66b36dc608f1",
"requested_by_contact_id": "bec29508-f629-41ae-9e4d-f67ec193377b",
"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-09-21T02:59:27.7329384+00:00",
"due_date": "2026-09-21T02:59:27.7329384+00:00",
"date_create": "2026-09-21T02:59:27.7329384+00:00",
"date_update": "2026-09-21T02:59:27.7329384+00:00",
"date_closed": "2026-09-21T02:59:27.7329384+00:00",
"suggested_user_id": "68ffe011-3367-4b26-86b1-ec94e75a04e3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2c5c5707-5d5c-4dae-9f00-033d53e97c44",
"db_language_id": "e77fe32a-d59a-4e6d-a550-50b4d577b9d2",
"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-09-21T02:59:27.7329384+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b3d14bc1-0b35-4cf0-a94a-e8ebdeb6952c",
"sales_organization": {
"id": "44fa6cb5-8102-451d-bf89-1fc7f2926411",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b4a0ed5-c271-4f19-a0ec-14715d031cf0",
"db_currency_id": "006efe50-f296-479d-8617-bcc13bdbc5ed",
"db_language_id": "aad50a1c-93f4-44fd-9fbe-b49440dfdf48",
"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-09-21T02:59:27.7329384+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "71c60fe3-86a4-4cae-9793-48d860348e82",
"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": "dc4eb008-b5a2-4c7f-9b4b-497c8c76df46",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-21T02:59:27.7329384+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c17ea397-cfd7-42d3-895e-f64e5a5a6ad0"
},
"suggested_date_start": "2026-09-21T02:59:27.7329384+00:00",
"skill_id": "aff55a59-ccd4-42b7-8066-a474c6837478",
"skill_code": "sample string 32",
"skill": {
"id": "cba7fe51-18ae-4852-b53e-0d073277a2fb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c80d4372-ed38-40b8-9647-0c6dd932a02d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "44fa6cb5-8102-451d-bf89-1fc7f2926411",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b4a0ed5-c271-4f19-a0ec-14715d031cf0",
"db_currency_id": "006efe50-f296-479d-8617-bcc13bdbc5ed",
"db_language_id": "aad50a1c-93f4-44fd-9fbe-b49440dfdf48",
"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-09-21T02:59:27.7329384+00:00"
},
"modified_dateutc": "2026-09-21T02:59:27.7329384+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1ed5c2bc-1de6-45c9-a828-5ad78122c600",
"date_reported_by_company": "2026-09-21T02:59:27.7329384+00:00",
"id2": 36,
"company_id": "0882087d-0966-47d1-8a57-f435dbf15c60",
"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": "1edca86a-7858-423b-8d59-c797c35d226f",
"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-09-21T02:59:27.7329384+00:00"
},
"work_instruction_details_id": "58b630b9-dc80-4f13-b391-0c41a2da8e75",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "da26abff-96f3-4227-af88-8cb1ca51ec8d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "65c3a415-3d85-45b7-9887-61f9a01e9090",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-21T02:59:27.7329384+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": "02bc8ca5-5236-4696-adca-2b0ee915fcca",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-21T02:59:27.7329384+00:00"
}