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": "f4490bbf-e229-4b2e-8c2e-e0720b799396",
"jobs_id": "3713c24d-90ef-4ea8-9fff-72812a05c11d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f47778c0-9e29-41ed-9c28-26c5d05a4c6c",
"_parent_id": "1f7bfc7c-5410-4709-8540-32e4c3a2d4f9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9192fddc-373e-4728-8cf9-476e8ef19190",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c6eba3f2-323e-4d52-a0a3-1c305cc9af99",
"_parent_id": "7b8a7cf6-2dfe-4ce2-a61e-146e69aab5c7",
"root_parent_id": "5ece132f-df6a-4553-ae51-72dc2ad369ec",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b89889bc-6254-438f-a049-51383fcade73",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "10acf023-feb8-4fa3-803d-1c56f926bfd3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a557294c-7105-4fff-8382-8027be6e6518",
"_parent_code": "sample string 6",
"sales_organization_id": "a573013a-8bbf-439d-93da-1ece422ed33c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5adcd307-c974-4acc-99cd-27a330a4dbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaa45015-f179-415b-8f72-d866f94b02dd",
"db_currency_id": "aba71642-e80e-479a-9d0d-71b731024e55",
"db_language_id": "28579e51-a696-43ba-849a-c7143ef01d96",
"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-12-13T08:03:16.009134+00:00"
},
"modified_dateutc": "2025-12-13T08:03:16.009134+00:00"
},
"equipment_model_id": "06e6e2ae-067e-4b5e-b5d9-0562c367b81c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "98fa2c15-df04-4134-86b0-d7c78531e682",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e1cd912b-fa61-49eb-88d4-662ceea321eb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "de15070b-f976-42f7-b97a-bb789f9a7a9d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b291f4eb-8597-41ed-bf56-8a8e50032e0f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5adcd307-c974-4acc-99cd-27a330a4dbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaa45015-f179-415b-8f72-d866f94b02dd",
"db_currency_id": "aba71642-e80e-479a-9d0d-71b731024e55",
"db_language_id": "28579e51-a696-43ba-849a-c7143ef01d96",
"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-12-13T08:03:16.009134+00:00"
},
"modified_dateutc": "2025-12-13T08:03:16.009134+00:00"
},
"equipment_family_id": "c2f7fcd1-c4d3-4a38-a939-da292fcd7a04",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "10acf023-feb8-4fa3-803d-1c56f926bfd3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a557294c-7105-4fff-8382-8027be6e6518",
"_parent_code": "sample string 6",
"sales_organization_id": "a573013a-8bbf-439d-93da-1ece422ed33c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5adcd307-c974-4acc-99cd-27a330a4dbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaa45015-f179-415b-8f72-d866f94b02dd",
"db_currency_id": "aba71642-e80e-479a-9d0d-71b731024e55",
"db_language_id": "28579e51-a696-43ba-849a-c7143ef01d96",
"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-12-13T08:03:16.009134+00:00"
},
"modified_dateutc": "2025-12-13T08:03:16.009134+00:00"
},
"date_in_production_since": "2025-12-13T08:03:16.009134+00:00",
"date_out_of_production_since": "2025-12-13T08:03:16.009134+00:00",
"date_end_support": "2025-12-13T08:03:16.009134+00:00",
"sales_organization_id": "0347840b-0c93-4e30-aab5-1d4dfc515e29",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5adcd307-c974-4acc-99cd-27a330a4dbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaa45015-f179-415b-8f72-d866f94b02dd",
"db_currency_id": "aba71642-e80e-479a-9d0d-71b731024e55",
"db_language_id": "28579e51-a696-43ba-849a-c7143ef01d96",
"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-12-13T08:03:16.009134+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-12-13T08:03:16.009134+00:00"
},
"project_status_id": "235cb24c-9d10-4396-b0ee-7a0e92cf21f5",
"project_status_code": "sample string 10",
"project_status": {
"id": "2a728987-864c-4483-a133-b4bf4e041ccb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "da7dd94d-225e-4c58-9224-c5ca26996715",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5adcd307-c974-4acc-99cd-27a330a4dbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaa45015-f179-415b-8f72-d866f94b02dd",
"db_currency_id": "aba71642-e80e-479a-9d0d-71b731024e55",
"db_language_id": "28579e51-a696-43ba-849a-c7143ef01d96",
"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-12-13T08:03:16.009134+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-13T08:03:16.009134+00:00"
},
"company_id": "385f1d86-f23e-4b30-958e-41a9fd6ac497",
"company_code": "sample string 12",
"db_address_id": "a54329eb-1770-4b58-b985-40833f3b45e0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c0a2ca8b-ee3c-4b7d-9833-45612b90ecb4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8dc4ee57-9bbb-43c2-b011-d2f26ba78d5a",
"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-12-13T08:03:16.009134+00:00",
"date_create": "2025-12-13T08:03:16.009134+00:00",
"date_update": "2025-12-13T08:03:16.009134+00:00",
"updated_by_user_id": "f2f01f73-1516-4d56-bc8d-63d9cce94122",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-13T08:03:16.009134+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-12-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-13T08:03:16.009134+00:00",
"date_last_job": "2025-12-13T08:03:16.009134+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-13T08:03:16.0247596+00:00",
"modified_dateutc": "2025-12-13T08:03:16.0247596+00:00",
"is_mobile_installation": true
},
"job_type_id": "d0d56fd8-6278-4159-b653-75bbc76bdfe3",
"job_type_code": "sample string 7",
"job_type": {
"id": "55b3f1d8-16f5-4740-b6f6-b6cc40d9e279",
"name": "sample string 2",
"sales_organization_id": "0c76dab6-8ba3-4cf5-9cde-d067143b03e3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-13T08:03:16.0247596+00:00",
"code": "sample string 7"
},
"job_priority_id": "3b5a340c-4855-4e56-b4ed-cc3d905e68b5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "21690358-add4-4cc6-80fe-eea69bbabe9a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ee83ec2e-14c6-4dcb-9e07-cc49edad4e11",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5adcd307-c974-4acc-99cd-27a330a4dbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaa45015-f179-415b-8f72-d866f94b02dd",
"db_currency_id": "aba71642-e80e-479a-9d0d-71b731024e55",
"db_language_id": "28579e51-a696-43ba-849a-c7143ef01d96",
"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-12-13T08:03:16.009134+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-13T08:03:16.0247596+00:00"
},
"job_status_id": "5737de3c-3b6d-4288-b44d-770d4c8f0627",
"job_status_code": "sample string 11",
"db_address_id": "25332413-a81a-40e4-b953-de4e564735e2",
"contact_id": "b8522d91-047d-4988-9ed4-e2a1469d9038",
"requested_by_company_id": "6b6cf6c8-272f-420e-a338-10994f1b1b01",
"requested_by_contact_id": "59af06f1-706b-45de-93be-7cf8b5489b63",
"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-12-13T08:03:16.0247596+00:00",
"due_date": "2025-12-13T08:03:16.0247596+00:00",
"date_create": "2025-12-13T08:03:16.0247596+00:00",
"date_update": "2025-12-13T08:03:16.0247596+00:00",
"date_closed": "2025-12-13T08:03:16.0247596+00:00",
"suggested_user_id": "0c6922a0-c427-4b67-9699-cd2ea83e13ff",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2683d50f-b54a-4b1b-b19f-9f420bdc6acd",
"db_language_id": "9f9889c3-4671-4ce0-a654-ae22a33e4291",
"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-12-13T08:03:16.0247596+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ff02e44c-7c26-44b7-8dea-dc041569c605",
"sales_organization": {
"id": "5adcd307-c974-4acc-99cd-27a330a4dbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaa45015-f179-415b-8f72-d866f94b02dd",
"db_currency_id": "aba71642-e80e-479a-9d0d-71b731024e55",
"db_language_id": "28579e51-a696-43ba-849a-c7143ef01d96",
"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-12-13T08:03:16.009134+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a4b81b78-b7c0-4798-9953-7b660c052253",
"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": "36b85fe6-8caf-4fbe-ba59-2d9cd20ffdc3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-13T08:03:16.0247596+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "63c4a816-8158-4d9d-ade5-c7f83b0dd4c7"
},
"suggested_date_start": "2025-12-13T08:03:16.0247596+00:00",
"skill_id": "7fec5a17-1995-4563-9336-252029160e15",
"skill_code": "sample string 32",
"skill": {
"id": "e1e2f28f-ab30-426b-8351-aae6070244ac",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "12437b0a-812b-4c6f-8eda-6a3786f75c64",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5adcd307-c974-4acc-99cd-27a330a4dbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaa45015-f179-415b-8f72-d866f94b02dd",
"db_currency_id": "aba71642-e80e-479a-9d0d-71b731024e55",
"db_language_id": "28579e51-a696-43ba-849a-c7143ef01d96",
"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-12-13T08:03:16.009134+00:00"
},
"modified_dateutc": "2025-12-13T08:03:16.0247596+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f5be3f87-dd25-4cbb-add6-a60afa75ab78",
"date_reported_by_company": "2025-12-13T08:03:16.0247596+00:00",
"id2": 36,
"company_id": "fa52dd5a-82aa-4830-ae25-b9358f71d107",
"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": "1956374a-a557-4603-8cc0-30833421fd79",
"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-12-13T08:03:16.0247596+00:00"
},
"work_instruction_details_id": "af5d0b2f-54aa-44cc-b68c-37c35bae0668",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fb74f405-940b-4c22-9d95-f4111f6eda27",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5f2fdd46-d47f-4f22-9045-c7ee699a935a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-13T08:03:16.0247596+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": "f23a2e93-d240-4a44-812e-226a1f0e0a97",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-13T08:03:16.0247596+00:00"
}