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": "628871f9-6510-4fb9-8528-d5716170a525",
"jobs_id": "01e7ef26-fb9b-43d7-9c82-34cf163c7f3d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0824ab87-76fa-49d5-ac39-4c651efd6981",
"_parent_id": "ec49ab98-2437-469f-96e3-76a40c2cc863",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b5c3e6c8-f5c3-4f3d-a15a-5b6117576b46",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c6cbb734-31c0-4fb1-96ba-12430e89fa9a",
"_parent_id": "311562c4-278c-4a03-855a-2b56c3d03b2c",
"root_parent_id": "5c14e46f-69b3-4f98-aa8e-15d5967edf1e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "42ab6835-46b9-4dbf-bea5-1be88f138ed2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e75c5c6b-a966-487b-96f7-54487bd5054e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ba94b2c1-6e9b-4801-b26e-7bb2f95a94ca",
"_parent_code": "sample string 6",
"sales_organization_id": "ac11e835-c518-4fd3-8609-ed5aabac89f0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0824aa51-99bf-4e6b-9972-16d545f78368",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76ce9b2c-428b-43a8-b737-d980ac943db9",
"db_currency_id": "c6fe30d8-5795-438d-825c-c750f6bec71f",
"db_language_id": "5bdb04d8-702e-46c5-8067-9b3dbad4b83e",
"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-10-21T08:10:52.8525966+00:00"
},
"modified_dateutc": "2026-10-21T08:10:52.8632573+00:00"
},
"equipment_model_id": "f1881b8b-2209-4577-b9b5-bbd514bd41d1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ca816867-80df-4779-9cf1-a571b0c57a80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7c6558ef-6ef9-4642-ae5c-4d4508b40edf",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "698a03d2-5ef4-4c6a-b84e-d29ced673b77",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a66aa215-c7b7-470a-a436-b2b6c079e7f5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0824aa51-99bf-4e6b-9972-16d545f78368",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76ce9b2c-428b-43a8-b737-d980ac943db9",
"db_currency_id": "c6fe30d8-5795-438d-825c-c750f6bec71f",
"db_language_id": "5bdb04d8-702e-46c5-8067-9b3dbad4b83e",
"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-10-21T08:10:52.8525966+00:00"
},
"modified_dateutc": "2026-10-21T08:10:52.8632573+00:00"
},
"equipment_family_id": "aa61886e-7bef-41ce-8edd-59693376c72d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e75c5c6b-a966-487b-96f7-54487bd5054e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ba94b2c1-6e9b-4801-b26e-7bb2f95a94ca",
"_parent_code": "sample string 6",
"sales_organization_id": "ac11e835-c518-4fd3-8609-ed5aabac89f0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0824aa51-99bf-4e6b-9972-16d545f78368",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76ce9b2c-428b-43a8-b737-d980ac943db9",
"db_currency_id": "c6fe30d8-5795-438d-825c-c750f6bec71f",
"db_language_id": "5bdb04d8-702e-46c5-8067-9b3dbad4b83e",
"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-10-21T08:10:52.8525966+00:00"
},
"modified_dateutc": "2026-10-21T08:10:52.8632573+00:00"
},
"date_in_production_since": "2026-10-21T08:10:52.8632573+00:00",
"date_out_of_production_since": "2026-10-21T08:10:52.8632573+00:00",
"date_end_support": "2026-10-21T08:10:52.8632573+00:00",
"sales_organization_id": "110c4403-1a21-40fb-97e5-447f656d3977",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0824aa51-99bf-4e6b-9972-16d545f78368",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76ce9b2c-428b-43a8-b737-d980ac943db9",
"db_currency_id": "c6fe30d8-5795-438d-825c-c750f6bec71f",
"db_language_id": "5bdb04d8-702e-46c5-8067-9b3dbad4b83e",
"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-10-21T08:10:52.8525966+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-10-21T08:10:52.8632573+00:00"
},
"project_status_id": "d81eb020-d7a0-4c41-82b3-d27c49e851f5",
"project_status_code": "sample string 10",
"project_status": {
"id": "19b11bbd-4c26-4e08-afd2-a1f16a696489",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "db0e681d-5ce4-4521-8109-2714f9e9a78d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0824aa51-99bf-4e6b-9972-16d545f78368",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76ce9b2c-428b-43a8-b737-d980ac943db9",
"db_currency_id": "c6fe30d8-5795-438d-825c-c750f6bec71f",
"db_language_id": "5bdb04d8-702e-46c5-8067-9b3dbad4b83e",
"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-10-21T08:10:52.8525966+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-21T08:10:52.8632573+00:00"
},
"company_id": "a5813725-7250-457b-86a5-026166efe515",
"company_code": "sample string 12",
"db_address_id": "fc6c1352-74fb-4792-85e8-8f124523d41c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3647879c-0146-4721-9db9-fc6e3236b02d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ba891aa4-d9a6-4f9d-8237-1dc1dff68a8d",
"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-10-21T08:10:52.8632573+00:00",
"date_create": "2026-10-21T08:10:52.8632573+00:00",
"date_update": "2026-10-21T08:10:52.8632573+00:00",
"updated_by_user_id": "c6b2ac13-6c62-4c1a-9650-aad8bc5c1129",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-21T08:10:52.8632573+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-10-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-21T08:10:52.8632573+00:00",
"date_last_job": "2026-10-21T08:10:52.8632573+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-21T08:10:52.8632573+00:00",
"modified_dateutc": "2026-10-21T08:10:52.8632573+00:00",
"is_mobile_installation": true
},
"job_type_id": "af2495cf-8178-4018-afa2-5fcbeb9cb846",
"job_type_code": "sample string 7",
"job_type": {
"id": "8f432603-10fa-4da3-a3ee-f8fe75254578",
"name": "sample string 2",
"sales_organization_id": "b0f0ebb9-1bbe-4287-963d-771a14ae6dd0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-21T08:10:52.8632573+00:00",
"code": "sample string 7"
},
"job_priority_id": "0ac36622-153c-4bc6-8c87-c7a93a8c4c30",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "92f183e3-01a6-474e-929d-ffedca729a12",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "81c7937c-08b2-41be-aff4-345489c691c6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0824aa51-99bf-4e6b-9972-16d545f78368",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76ce9b2c-428b-43a8-b737-d980ac943db9",
"db_currency_id": "c6fe30d8-5795-438d-825c-c750f6bec71f",
"db_language_id": "5bdb04d8-702e-46c5-8067-9b3dbad4b83e",
"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-10-21T08:10:52.8525966+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-21T08:10:52.8632573+00:00"
},
"job_status_id": "a43a074e-0add-48a4-ae37-d90464c320f6",
"job_status_code": "sample string 11",
"db_address_id": "3ad0f3da-e22a-4402-ae13-c9fc3476fb01",
"contact_id": "84aafe2e-27e7-44d4-aa11-92f18a679b32",
"requested_by_company_id": "3a001e70-65e4-4a1f-b355-9d919d6883c2",
"requested_by_contact_id": "2bb56313-28f4-4f29-a9f9-7ed309b8a2f9",
"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-10-21T08:10:52.8632573+00:00",
"due_date": "2026-10-21T08:10:52.8632573+00:00",
"date_create": "2026-10-21T08:10:52.8632573+00:00",
"date_update": "2026-10-21T08:10:52.8632573+00:00",
"date_closed": "2026-10-21T08:10:52.8632573+00:00",
"suggested_user_id": "2015d722-5e8c-481d-b240-1314f1b247b2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ebec9300-ecb6-4eb2-913b-90897161e8fc",
"db_language_id": "f893a15c-ad1e-4b1d-86fc-da01d5c18def",
"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-10-21T08:10:52.8632573+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "33ab79da-5881-41f6-ab40-9d4a12df8d22",
"sales_organization": {
"id": "0824aa51-99bf-4e6b-9972-16d545f78368",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76ce9b2c-428b-43a8-b737-d980ac943db9",
"db_currency_id": "c6fe30d8-5795-438d-825c-c750f6bec71f",
"db_language_id": "5bdb04d8-702e-46c5-8067-9b3dbad4b83e",
"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-10-21T08:10:52.8525966+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c05aec59-7f5e-40fc-99ed-263c10fad1c0",
"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": "fc26148d-5b7e-46ba-b119-c706cfaf9dec",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-21T08:10:52.8632573+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b34ea2ce-ddd3-46f2-8c16-8071a261ce8d"
},
"suggested_date_start": "2026-10-21T08:10:52.8632573+00:00",
"skill_id": "9bd867ab-6396-4670-ab31-6e5e9f130fb7",
"skill_code": "sample string 32",
"skill": {
"id": "71304d44-092e-4d21-8af0-5ee473d72cf4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8d18bafb-11a9-461d-90c9-2b38d41ee895",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0824aa51-99bf-4e6b-9972-16d545f78368",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76ce9b2c-428b-43a8-b737-d980ac943db9",
"db_currency_id": "c6fe30d8-5795-438d-825c-c750f6bec71f",
"db_language_id": "5bdb04d8-702e-46c5-8067-9b3dbad4b83e",
"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-10-21T08:10:52.8525966+00:00"
},
"modified_dateutc": "2026-10-21T08:10:52.8632573+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e54add0d-03ef-41b4-8c32-34d1b3f79336",
"date_reported_by_company": "2026-10-21T08:10:52.8632573+00:00",
"id2": 36,
"company_id": "8d23b99b-377b-49c9-9e46-d511f8e203a7",
"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": "1a25de58-7d52-48cc-88d3-b357e3dd6d69",
"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-10-21T08:10:52.8632573+00:00"
},
"work_instruction_details_id": "544767ee-b1d4-4a1e-82d7-5cd92b346ea0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "357451d1-8e4f-4884-b311-d693b1b29706",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "efb78f2a-6ddd-406d-bed5-0a7200c5966e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-21T08:10:52.8632573+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": "17ded710-4c76-434e-b816-ac3e259207bd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-21T08:10:52.8632573+00:00"
}