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": "74c33873-dfbb-4ea2-8811-e6cf91875778",
"jobs_id": "83cb7654-4414-4ee7-991e-1ab4d1e23a75",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5338deeb-b3a1-44ee-8835-2d6e9737e377",
"_parent_id": "7c3d40de-6f96-4884-a264-36d6ed60da33",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "097c44e0-ce3c-4f28-a276-6f36ef028f6a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5ec7ff9a-8544-47d8-afab-91b0e77c63ae",
"_parent_id": "39c7b6dc-27e3-434b-bf73-7fe6569150b8",
"root_parent_id": "511a8e94-a1e6-487b-98e6-644bb0cf0152",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "84a18c1b-3ffc-4de9-8c8e-718d8457dfe5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0de0f587-711d-45fc-a2eb-50bdfa3ca8a6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3c0a43e8-ac35-40f4-8add-0434d2ec752b",
"_parent_code": "sample string 6",
"sales_organization_id": "df8200c8-2cc4-434c-bbe0-39334b5eb16f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2f7ab9dc-5ae4-42fa-a3ba-e758089785ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a22623a-f350-4a9a-9ae9-3cfd658a1866",
"db_currency_id": "4845634a-88f8-44d3-a1c0-8cd8bdd10dca",
"db_language_id": "2bc2aab8-097d-4dac-9e68-6f604021abdb",
"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-04-24T00:54:16.3410605+00:00"
},
"modified_dateutc": "2026-04-24T00:54:16.3410605+00:00"
},
"equipment_model_id": "afd118e1-797f-4db6-be1d-d7ab7ee6d4b9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "26bfa089-4904-47ee-baf7-7b2564044877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b87e0d61-0e60-4bbe-b555-a55014c127f5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5f77e6fd-bda2-466b-9655-c48638f63519",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8f720a00-5402-4a4f-be6b-d01a2c20e952",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2f7ab9dc-5ae4-42fa-a3ba-e758089785ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a22623a-f350-4a9a-9ae9-3cfd658a1866",
"db_currency_id": "4845634a-88f8-44d3-a1c0-8cd8bdd10dca",
"db_language_id": "2bc2aab8-097d-4dac-9e68-6f604021abdb",
"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-04-24T00:54:16.3410605+00:00"
},
"modified_dateutc": "2026-04-24T00:54:16.3410605+00:00"
},
"equipment_family_id": "cfc9981a-8d5f-4a52-8da9-1f77d861ca37",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0de0f587-711d-45fc-a2eb-50bdfa3ca8a6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3c0a43e8-ac35-40f4-8add-0434d2ec752b",
"_parent_code": "sample string 6",
"sales_organization_id": "df8200c8-2cc4-434c-bbe0-39334b5eb16f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2f7ab9dc-5ae4-42fa-a3ba-e758089785ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a22623a-f350-4a9a-9ae9-3cfd658a1866",
"db_currency_id": "4845634a-88f8-44d3-a1c0-8cd8bdd10dca",
"db_language_id": "2bc2aab8-097d-4dac-9e68-6f604021abdb",
"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-04-24T00:54:16.3410605+00:00"
},
"modified_dateutc": "2026-04-24T00:54:16.3410605+00:00"
},
"date_in_production_since": "2026-04-24T00:54:16.3410605+00:00",
"date_out_of_production_since": "2026-04-24T00:54:16.3410605+00:00",
"date_end_support": "2026-04-24T00:54:16.3410605+00:00",
"sales_organization_id": "d4ceaeaf-4697-4f04-a3a5-d6fbe2f7ea60",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2f7ab9dc-5ae4-42fa-a3ba-e758089785ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a22623a-f350-4a9a-9ae9-3cfd658a1866",
"db_currency_id": "4845634a-88f8-44d3-a1c0-8cd8bdd10dca",
"db_language_id": "2bc2aab8-097d-4dac-9e68-6f604021abdb",
"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-04-24T00:54:16.3410605+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-04-24T00:54:16.3410605+00:00"
},
"project_status_id": "b0f1191d-84a2-41fa-a578-0474e36861c0",
"project_status_code": "sample string 10",
"project_status": {
"id": "747028f8-a152-4775-9f26-2cc014865096",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3e734754-8f11-427e-897b-6557d8fc9528",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2f7ab9dc-5ae4-42fa-a3ba-e758089785ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a22623a-f350-4a9a-9ae9-3cfd658a1866",
"db_currency_id": "4845634a-88f8-44d3-a1c0-8cd8bdd10dca",
"db_language_id": "2bc2aab8-097d-4dac-9e68-6f604021abdb",
"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-04-24T00:54:16.3410605+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T00:54:16.3410605+00:00"
},
"company_id": "c15cb28c-08f2-4932-9aaf-17021fe592be",
"company_code": "sample string 12",
"db_address_id": "c634388d-29fd-45ca-aa7c-ba7233946708",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "20d4039c-16d4-40bf-9dd4-1f92bfed3c72",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ec66e206-63cf-4443-9aea-162e9518c852",
"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-04-24T00:54:16.3410605+00:00",
"date_create": "2026-04-24T00:54:16.3410605+00:00",
"date_update": "2026-04-24T00:54:16.3410605+00:00",
"updated_by_user_id": "dec48ea7-3d0b-4962-aa0f-3dab6cf35229",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-24T00:54:16.3410605+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-04-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-24T00:54:16.3410605+00:00",
"date_last_job": "2026-04-24T00:54:16.3410605+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-24T00:54:16.3410605+00:00",
"modified_dateutc": "2026-04-24T00:54:16.3410605+00:00",
"is_mobile_installation": true
},
"job_type_id": "c3332fbf-0d69-466c-8b2b-33df0a87073c",
"job_type_code": "sample string 7",
"job_type": {
"id": "afce3917-c71b-4c08-b716-bbad05914c39",
"name": "sample string 2",
"sales_organization_id": "275ba885-c95e-4960-9ad2-345b3e87897f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-24T00:54:16.3410605+00:00",
"code": "sample string 7"
},
"job_priority_id": "c34cc12a-a535-4595-b0a3-218607a0ffa8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e1007810-f8b8-424b-8215-6b4dca0fb96c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "276cfe97-83f3-4043-b8fd-311bbd3e954c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2f7ab9dc-5ae4-42fa-a3ba-e758089785ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a22623a-f350-4a9a-9ae9-3cfd658a1866",
"db_currency_id": "4845634a-88f8-44d3-a1c0-8cd8bdd10dca",
"db_language_id": "2bc2aab8-097d-4dac-9e68-6f604021abdb",
"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-04-24T00:54:16.3410605+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T00:54:16.3410605+00:00"
},
"job_status_id": "379a002a-487e-4292-ba94-501476193fe4",
"job_status_code": "sample string 11",
"db_address_id": "bdd517eb-53b1-4459-8ee4-1183c7b5c122",
"contact_id": "be55b0d7-add5-4fb6-a9fd-838d9117965a",
"requested_by_company_id": "2f15a1ee-fad4-42f7-b254-418d4d9a9c4d",
"requested_by_contact_id": "577f1297-d47e-483f-9e82-ed12a3a91f45",
"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-04-24T00:54:16.3410605+00:00",
"due_date": "2026-04-24T00:54:16.3410605+00:00",
"date_create": "2026-04-24T00:54:16.3410605+00:00",
"date_update": "2026-04-24T00:54:16.3410605+00:00",
"date_closed": "2026-04-24T00:54:16.3410605+00:00",
"suggested_user_id": "830a5db3-b02f-4305-b187-b140e265901e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "43c1dafa-f883-4951-b094-31be7abeb0e9",
"db_language_id": "ef563770-e85c-4943-a9a3-7a286710cd4c",
"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-04-24T00:54:16.3410605+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "03b22c4f-582a-4828-9366-55c6c4df918d",
"sales_organization": {
"id": "2f7ab9dc-5ae4-42fa-a3ba-e758089785ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a22623a-f350-4a9a-9ae9-3cfd658a1866",
"db_currency_id": "4845634a-88f8-44d3-a1c0-8cd8bdd10dca",
"db_language_id": "2bc2aab8-097d-4dac-9e68-6f604021abdb",
"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-04-24T00:54:16.3410605+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5eeb7f73-44ef-47ff-9243-6c814031f1b4",
"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": "0eef28d0-901f-44b3-b1e9-a44c79d17ec7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-24T00:54:16.3410605+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4b5c6be4-8c9f-4613-8ea1-84f1263a6caa"
},
"suggested_date_start": "2026-04-24T00:54:16.3410605+00:00",
"skill_id": "332a1623-1547-4920-9b7e-96ca70039479",
"skill_code": "sample string 32",
"skill": {
"id": "12a32905-1a4a-41cf-b8cc-ad8a41db2281",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3a661b59-8a9a-4c2f-8ec3-2b6946ec19d4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2f7ab9dc-5ae4-42fa-a3ba-e758089785ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a22623a-f350-4a9a-9ae9-3cfd658a1866",
"db_currency_id": "4845634a-88f8-44d3-a1c0-8cd8bdd10dca",
"db_language_id": "2bc2aab8-097d-4dac-9e68-6f604021abdb",
"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-04-24T00:54:16.3410605+00:00"
},
"modified_dateutc": "2026-04-24T00:54:16.3410605+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c404a30d-afe4-4746-9559-5b80107b3340",
"date_reported_by_company": "2026-04-24T00:54:16.3410605+00:00",
"id2": 36,
"company_id": "d3772bb3-bbab-437e-9c6d-49f6901e585b",
"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": "4ade3f94-c8fc-423f-bc9b-7c22f3767a79",
"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-04-24T00:54:16.3410605+00:00"
},
"work_instruction_details_id": "5fd3ea40-c49d-4c64-86b9-c94af810f55c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1a2c3321-1961-4a3d-9ef8-37e8ab7cab1f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b7e4f2b3-aa2c-4453-8f09-5f0e9256c4f9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-24T00:54:16.3410605+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": "d69727c3-d04a-4927-a676-cdc6ea7d967d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-24T00:54:16.3410605+00:00"
}