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": "d6bcd3dc-6862-47db-bd5b-26e7e673359c",
"jobs_id": "668fb69d-1fda-4d31-936c-dc262ff37fdc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "26ad9c5b-1005-4381-b75a-11b3507aabb7",
"_parent_id": "14993a0c-423d-4197-8dfd-0129d29ff9a3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e8d39a31-28c1-4052-9790-c207848013bf",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7ef3583c-d035-477e-9416-f99695753e70",
"_parent_id": "6ccead6a-bf52-46a3-a9e8-a8ee036a4cf9",
"root_parent_id": "1acb2d8c-9391-4ed2-90eb-e03d6c88b108",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5fa73f29-46fb-49d3-8f83-277c8ff1d22a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "077657f6-576d-4296-9280-48d84c6d5a36",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e5deb39a-bae4-41eb-a542-9873cc90a8c4",
"_parent_code": "sample string 6",
"sales_organization_id": "d995210a-83a3-4e9f-b9cf-754862c03cef",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d0105383-2e68-48a3-aa2a-337588ae09b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "371cbeca-1b18-4782-a15c-14ed2befd124",
"db_currency_id": "c2b16f2f-a65c-46a3-8e66-e55554411fc5",
"db_language_id": "fb5f0f33-ed9d-48a2-8c44-443661de4dc2",
"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-10-22T03:10:34.4263998+00:00"
},
"modified_dateutc": "2025-10-22T03:10:34.4263998+00:00"
},
"equipment_model_id": "d8869b0f-d2cf-4226-8902-941cbeed9366",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e0974690-f158-4673-b362-884935fb4613",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f173fc99-8b9f-4cbf-9571-b2fdf0af8043",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d095d3a3-4627-49a4-90c7-96dc8ea6aff9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c9ec62c9-e321-46f0-b56a-d3b2da037176",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d0105383-2e68-48a3-aa2a-337588ae09b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "371cbeca-1b18-4782-a15c-14ed2befd124",
"db_currency_id": "c2b16f2f-a65c-46a3-8e66-e55554411fc5",
"db_language_id": "fb5f0f33-ed9d-48a2-8c44-443661de4dc2",
"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-10-22T03:10:34.4263998+00:00"
},
"modified_dateutc": "2025-10-22T03:10:34.4263998+00:00"
},
"equipment_family_id": "01548ac3-a098-4934-8c50-04c6ae7c48aa",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "077657f6-576d-4296-9280-48d84c6d5a36",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e5deb39a-bae4-41eb-a542-9873cc90a8c4",
"_parent_code": "sample string 6",
"sales_organization_id": "d995210a-83a3-4e9f-b9cf-754862c03cef",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d0105383-2e68-48a3-aa2a-337588ae09b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "371cbeca-1b18-4782-a15c-14ed2befd124",
"db_currency_id": "c2b16f2f-a65c-46a3-8e66-e55554411fc5",
"db_language_id": "fb5f0f33-ed9d-48a2-8c44-443661de4dc2",
"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-10-22T03:10:34.4263998+00:00"
},
"modified_dateutc": "2025-10-22T03:10:34.4263998+00:00"
},
"date_in_production_since": "2025-10-22T03:10:34.4263998+00:00",
"date_out_of_production_since": "2025-10-22T03:10:34.4263998+00:00",
"date_end_support": "2025-10-22T03:10:34.4263998+00:00",
"sales_organization_id": "7b7025ef-2d72-410e-9841-a45557c7a0fb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d0105383-2e68-48a3-aa2a-337588ae09b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "371cbeca-1b18-4782-a15c-14ed2befd124",
"db_currency_id": "c2b16f2f-a65c-46a3-8e66-e55554411fc5",
"db_language_id": "fb5f0f33-ed9d-48a2-8c44-443661de4dc2",
"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-10-22T03:10:34.4263998+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-10-22T03:10:34.4263998+00:00"
},
"project_status_id": "fae36efb-8846-49a5-9e70-901f844e7b83",
"project_status_code": "sample string 10",
"project_status": {
"id": "7e323076-ac4e-445b-b7c9-576cf4771789",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4eb4fc91-02eb-4ba4-b5af-c6e93b61bd2d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d0105383-2e68-48a3-aa2a-337588ae09b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "371cbeca-1b18-4782-a15c-14ed2befd124",
"db_currency_id": "c2b16f2f-a65c-46a3-8e66-e55554411fc5",
"db_language_id": "fb5f0f33-ed9d-48a2-8c44-443661de4dc2",
"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-10-22T03:10:34.4263998+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-22T03:10:34.4420274+00:00"
},
"company_id": "9d1006c0-4744-4698-813a-e9279242c03a",
"company_code": "sample string 12",
"db_address_id": "b595f1b7-c7e7-4f08-8d55-7b5b6e24e484",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "993d85f4-ddd8-4e10-bf26-a1e370ce7f82",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "90eff0b4-4325-4937-b8bf-4c6d37020eb3",
"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-10-22T03:10:34.4420274+00:00",
"date_create": "2025-10-22T03:10:34.4420274+00:00",
"date_update": "2025-10-22T03:10:34.4420274+00:00",
"updated_by_user_id": "773e3c5c-c55c-4716-9a37-fbed940766c5",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-22T03:10:34.4420274+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-10-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-22T03:10:34.4420274+00:00",
"date_last_job": "2025-10-22T03:10:34.4420274+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-22T03:10:34.4420274+00:00",
"modified_dateutc": "2025-10-22T03:10:34.4420274+00:00",
"is_mobile_installation": true
},
"job_type_id": "bf797281-ee80-4d03-adfb-e9b3c9cf4128",
"job_type_code": "sample string 7",
"job_type": {
"id": "64a60a65-8395-4515-8d51-56b394dfb9cc",
"name": "sample string 2",
"sales_organization_id": "a1206e9c-be9e-42a9-9cd0-454add24edf5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-22T03:10:34.4420274+00:00",
"code": "sample string 7"
},
"job_priority_id": "0c52b4f3-18d2-4681-9229-94839084bd05",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d262e2b0-9431-47d9-875f-f8a0a945e54f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e9db8f8b-239e-4701-8acd-592054bd95e2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d0105383-2e68-48a3-aa2a-337588ae09b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "371cbeca-1b18-4782-a15c-14ed2befd124",
"db_currency_id": "c2b16f2f-a65c-46a3-8e66-e55554411fc5",
"db_language_id": "fb5f0f33-ed9d-48a2-8c44-443661de4dc2",
"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-10-22T03:10:34.4263998+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-22T03:10:34.4420274+00:00"
},
"job_status_id": "15c89c69-345b-4ed4-9bbd-51c6787303e1",
"job_status_code": "sample string 11",
"db_address_id": "130a00f0-3239-4fc9-bdc5-98f5b09679b5",
"contact_id": "65b75db2-3604-40c2-a24e-b808b9bfc264",
"requested_by_company_id": "9a8eabfe-a9d0-4c97-b5bf-24b44e3c2946",
"requested_by_contact_id": "ebd1f941-93f3-4c8a-a64b-f8cf83c4511c",
"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-10-22T03:10:34.4420274+00:00",
"due_date": "2025-10-22T03:10:34.4420274+00:00",
"date_create": "2025-10-22T03:10:34.4420274+00:00",
"date_update": "2025-10-22T03:10:34.4420274+00:00",
"date_closed": "2025-10-22T03:10:34.4420274+00:00",
"suggested_user_id": "5736d74f-68a4-4c81-a229-52b099172c60",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "119b62df-3307-4d28-9320-ab3d3ed256b0",
"db_language_id": "05cfed40-6cd2-49d0-acaa-cf7e20e89848",
"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-10-22T03:10:34.4420274+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7af12914-aa89-4e52-bcce-2b555e0c61af",
"sales_organization": {
"id": "d0105383-2e68-48a3-aa2a-337588ae09b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "371cbeca-1b18-4782-a15c-14ed2befd124",
"db_currency_id": "c2b16f2f-a65c-46a3-8e66-e55554411fc5",
"db_language_id": "fb5f0f33-ed9d-48a2-8c44-443661de4dc2",
"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-10-22T03:10:34.4263998+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "60a8247f-0c33-48c6-94f7-a72479ea90db",
"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": "063d92f8-ecc2-436d-a121-3d972b6b5f8c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-22T03:10:34.4420274+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fc9e3b10-db41-49f0-a62b-0c1e72331d15"
},
"suggested_date_start": "2025-10-22T03:10:34.4420274+00:00",
"skill_id": "87e69fd3-cdfe-4dee-b3a1-d768d2c09312",
"skill_code": "sample string 32",
"skill": {
"id": "e56b1fd1-aaab-4448-9bad-7802fbfade02",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b57d0d23-e3a1-4410-90f7-c206a0bc191c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d0105383-2e68-48a3-aa2a-337588ae09b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "371cbeca-1b18-4782-a15c-14ed2befd124",
"db_currency_id": "c2b16f2f-a65c-46a3-8e66-e55554411fc5",
"db_language_id": "fb5f0f33-ed9d-48a2-8c44-443661de4dc2",
"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-10-22T03:10:34.4263998+00:00"
},
"modified_dateutc": "2025-10-22T03:10:34.4420274+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ffda0b6a-5920-4f77-81a3-28361cfa6aaa",
"date_reported_by_company": "2025-10-22T03:10:34.4420274+00:00",
"id2": 36,
"company_id": "dd78f468-49d1-4bcb-a4c3-04388bff2cef",
"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": "b49d0369-36af-4d20-a411-851bc96ed564",
"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-10-22T03:10:34.4420274+00:00"
},
"work_instruction_details_id": "193e1f9f-aeee-474c-afd9-b4c76358ecbd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bae60a13-7a2c-48af-a2fd-78683f965f49",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f4b38934-8a03-41fd-9abe-7aeb4d1c9c67",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-22T03:10:34.4420274+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": "acd9e214-a68b-4421-882b-e06cc715bd2c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-22T03:10:34.4420274+00:00"
}