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": "b49c9c97-0400-4718-abe8-c49b42917615",
"jobs_id": "09dc9a85-7fef-4d4c-bcd4-4af47115176b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7c41c2f0-fae6-40f4-a031-e97534639ca7",
"_parent_id": "82b41021-a747-48b5-9998-d05faac996e1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "20495ea9-7fae-4192-870e-0fedf95f17aa",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7877fb5a-9b09-4517-9f24-1763f9b9eb3d",
"_parent_id": "ccc0655c-417e-4797-aab7-164d39488c79",
"root_parent_id": "60f2f0f4-1cc1-48f5-926b-2501f599dd5e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3cd06122-f14a-493d-9bef-fc35c25f145a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ebe53e19-8ea5-4cb5-ad78-a76f96593156",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5c385935-5a10-4724-b4e0-15eed7a388df",
"_parent_code": "sample string 6",
"sales_organization_id": "369668b9-d004-4f44-b716-79fea419f6b2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "76d6ed64-04cd-4339-95c7-c40b0739d722",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e09b6031-baee-4ab4-a3cd-bd84f2cc4f5f",
"db_currency_id": "3f73345d-1e73-47c6-91d9-f124c1e9f0bd",
"db_language_id": "c90ecf03-743d-46be-98b2-770aaba2188e",
"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-02-26T09:59:34.9951557+00:00"
},
"modified_dateutc": "2026-02-26T09:59:34.9951557+00:00"
},
"equipment_model_id": "a7a3f4f9-0fee-433c-899b-81b1646c0156",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "296916b5-bffa-4a4d-b3cb-821f70b89fec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0ef15e7f-5c34-4998-b54e-0a2dbf7f90e8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2d1fa846-8b35-44f0-9ab3-0923b10065d6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8d77fc68-d75c-49be-8cc7-bf221d1b92aa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "76d6ed64-04cd-4339-95c7-c40b0739d722",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e09b6031-baee-4ab4-a3cd-bd84f2cc4f5f",
"db_currency_id": "3f73345d-1e73-47c6-91d9-f124c1e9f0bd",
"db_language_id": "c90ecf03-743d-46be-98b2-770aaba2188e",
"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-02-26T09:59:34.9951557+00:00"
},
"modified_dateutc": "2026-02-26T09:59:34.9951557+00:00"
},
"equipment_family_id": "c9fb9662-a50a-463a-8c37-eea8ca8d1305",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ebe53e19-8ea5-4cb5-ad78-a76f96593156",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5c385935-5a10-4724-b4e0-15eed7a388df",
"_parent_code": "sample string 6",
"sales_organization_id": "369668b9-d004-4f44-b716-79fea419f6b2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "76d6ed64-04cd-4339-95c7-c40b0739d722",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e09b6031-baee-4ab4-a3cd-bd84f2cc4f5f",
"db_currency_id": "3f73345d-1e73-47c6-91d9-f124c1e9f0bd",
"db_language_id": "c90ecf03-743d-46be-98b2-770aaba2188e",
"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-02-26T09:59:34.9951557+00:00"
},
"modified_dateutc": "2026-02-26T09:59:34.9951557+00:00"
},
"date_in_production_since": "2026-02-26T09:59:34.9951557+00:00",
"date_out_of_production_since": "2026-02-26T09:59:34.9951557+00:00",
"date_end_support": "2026-02-26T09:59:34.9951557+00:00",
"sales_organization_id": "4f9061b1-506a-45ea-a386-fcfcf4805a91",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "76d6ed64-04cd-4339-95c7-c40b0739d722",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e09b6031-baee-4ab4-a3cd-bd84f2cc4f5f",
"db_currency_id": "3f73345d-1e73-47c6-91d9-f124c1e9f0bd",
"db_language_id": "c90ecf03-743d-46be-98b2-770aaba2188e",
"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-02-26T09:59:34.9951557+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-02-26T09:59:34.9951557+00:00"
},
"project_status_id": "a5fb6938-5b16-44c4-9fb9-36d8b67e3a8a",
"project_status_code": "sample string 10",
"project_status": {
"id": "116a7175-4b19-4413-a048-11482abcfce4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "65a05b76-7d4e-4355-9580-038f8b058a1f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "76d6ed64-04cd-4339-95c7-c40b0739d722",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e09b6031-baee-4ab4-a3cd-bd84f2cc4f5f",
"db_currency_id": "3f73345d-1e73-47c6-91d9-f124c1e9f0bd",
"db_language_id": "c90ecf03-743d-46be-98b2-770aaba2188e",
"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-02-26T09:59:34.9951557+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-26T09:59:34.9951557+00:00"
},
"company_id": "4cbbba8f-e47e-432c-9fb9-b3bd2171e8da",
"company_code": "sample string 12",
"db_address_id": "2ec5f486-1c34-42e8-a096-a4e2af532f18",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f44aa0ea-f1c1-4342-8e71-d6623ea3c166",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6996ec6f-659b-4af3-babc-187e19cc8b3c",
"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-02-26T09:59:34.9951557+00:00",
"date_create": "2026-02-26T09:59:34.9951557+00:00",
"date_update": "2026-02-26T09:59:34.9951557+00:00",
"updated_by_user_id": "40ee4e44-6b46-4588-9045-03d3221c0145",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-26T09:59:34.9951557+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-02-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-26T09:59:34.9951557+00:00",
"date_last_job": "2026-02-26T09:59:34.9951557+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-26T09:59:34.9951557+00:00",
"modified_dateutc": "2026-02-26T09:59:34.9951557+00:00",
"is_mobile_installation": true
},
"job_type_id": "55738d65-0854-4e6c-8065-ef64701eb366",
"job_type_code": "sample string 7",
"job_type": {
"id": "7ea492f6-d99d-48a1-aded-568ba15c7d98",
"name": "sample string 2",
"sales_organization_id": "3be6fe43-d79f-4b82-aca2-0eb40c8ed41f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-26T09:59:34.9951557+00:00",
"code": "sample string 7"
},
"job_priority_id": "92bc9aa6-7aee-4488-815c-28410a811e91",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "55bf8995-1624-4c5b-b693-232659b2367b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "419273a9-a65c-40b8-8f4c-73ecd13959c8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "76d6ed64-04cd-4339-95c7-c40b0739d722",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e09b6031-baee-4ab4-a3cd-bd84f2cc4f5f",
"db_currency_id": "3f73345d-1e73-47c6-91d9-f124c1e9f0bd",
"db_language_id": "c90ecf03-743d-46be-98b2-770aaba2188e",
"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-02-26T09:59:34.9951557+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-26T09:59:34.9951557+00:00"
},
"job_status_id": "3395cbbc-10ad-4d55-bebb-24b2cf1648ee",
"job_status_code": "sample string 11",
"db_address_id": "ccc6626e-a88d-46eb-b392-c64f0be2c81f",
"contact_id": "668ccf52-85d7-4b68-aa24-510c71baac16",
"requested_by_company_id": "b1a64e26-573e-42c9-8491-b7ab2fd37b51",
"requested_by_contact_id": "fc486fbf-edb1-4433-8db9-689d1098c1e8",
"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-02-26T09:59:34.9951557+00:00",
"due_date": "2026-02-26T09:59:34.9951557+00:00",
"date_create": "2026-02-26T09:59:34.9951557+00:00",
"date_update": "2026-02-26T09:59:34.9951557+00:00",
"date_closed": "2026-02-26T09:59:34.9951557+00:00",
"suggested_user_id": "c399e831-0677-42e0-b72e-3779668ce414",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9bd3bd6b-86be-417b-a430-834c723d34fb",
"db_language_id": "d9229608-7dfa-447b-82c2-9e084022fef0",
"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-02-26T09:59:34.9951557+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "41da9990-eacc-4747-9c0c-91dc6c80df7b",
"sales_organization": {
"id": "76d6ed64-04cd-4339-95c7-c40b0739d722",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e09b6031-baee-4ab4-a3cd-bd84f2cc4f5f",
"db_currency_id": "3f73345d-1e73-47c6-91d9-f124c1e9f0bd",
"db_language_id": "c90ecf03-743d-46be-98b2-770aaba2188e",
"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-02-26T09:59:34.9951557+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fe903ece-f024-4de4-b72b-6dfc8e1c3635",
"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": "9c10d623-2558-410c-897d-68d16fd60f6b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-26T09:59:34.9951557+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b572145d-7bde-4b74-b918-5506d4709938"
},
"suggested_date_start": "2026-02-26T09:59:34.9951557+00:00",
"skill_id": "17323aef-c9a2-4eee-ba12-887049652a16",
"skill_code": "sample string 32",
"skill": {
"id": "1f75f7fb-3130-48c9-a886-017dec2c8998",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c4e05755-082d-4b1e-9b2f-1a4fd3e8fc1a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "76d6ed64-04cd-4339-95c7-c40b0739d722",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e09b6031-baee-4ab4-a3cd-bd84f2cc4f5f",
"db_currency_id": "3f73345d-1e73-47c6-91d9-f124c1e9f0bd",
"db_language_id": "c90ecf03-743d-46be-98b2-770aaba2188e",
"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-02-26T09:59:34.9951557+00:00"
},
"modified_dateutc": "2026-02-26T09:59:34.9951557+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6b9513a6-c7cd-4735-b2c7-5b7ad9c2d171",
"date_reported_by_company": "2026-02-26T09:59:34.9951557+00:00",
"id2": 36,
"company_id": "aa478dbc-ed33-4a77-978e-f2c025935cb8",
"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": "2ba61a3e-82a6-4c88-92bf-77ea86730e8a",
"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-02-26T09:59:34.9951557+00:00"
},
"work_instruction_details_id": "fd38b503-5f35-4114-bed1-dbbb96c86273",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cbda6918-2977-4257-8158-f0d1cd5675c3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b59cd154-d035-4419-9612-7e129cd34e54",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-26T09:59:34.9951557+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": "9d229a15-a1e2-46ff-a5f5-757b63ccb14c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-26T09:59:34.9951557+00:00"
}