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": "089416f2-846a-43aa-a7da-2fa34e2ba314",
"jobs_id": "8f1e46a9-b80a-447b-9d4d-7a87b01677ac",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d179172d-d66f-41a5-96c3-fc8afe5bf6ce",
"_parent_id": "156e5b42-68cd-4e2b-b5c9-dff2a3cf7b8f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "13c2f686-063f-42d1-a3ea-544939d6cb82",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f7035b52-38df-48b8-bf70-b6c72016e463",
"_parent_id": "2c8235cf-f7c8-4604-89af-bd08ed29a1cc",
"root_parent_id": "b3f29c42-4058-4404-91ac-c9efab1edc6b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a2025c5f-3709-4458-a562-70197b74c055",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "902eaaca-3a19-46fb-851e-629a3c0f9e21",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2610adb2-6993-454b-95fd-f0d10f591a6f",
"_parent_code": "sample string 6",
"sales_organization_id": "37dc71ab-e603-4d31-b15b-090deeb39eee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c8f9ae81-734d-48dc-9c85-8d10f64e3e43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c2db0e4-90e1-42fb-a678-f0bbe95ec398",
"db_currency_id": "219eed2c-fece-48ed-9b71-10eef3bcda0e",
"db_language_id": "1559ce17-6021-4873-9353-3fe3e76e4481",
"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-08-07T05:37:11.0047214+00:00"
},
"modified_dateutc": "2026-08-07T05:37:11.0047214+00:00"
},
"equipment_model_id": "6ddfa12b-5361-4807-a08d-7f00cb3774c0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9159d364-ffde-4775-977f-c19ace714b59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1c43381d-98c6-42ae-9aec-5885297ea1c4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a4454bc9-e3b0-4a38-998a-399401e87379",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "283dc948-d370-441b-bd7f-9c31926d5c6e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c8f9ae81-734d-48dc-9c85-8d10f64e3e43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c2db0e4-90e1-42fb-a678-f0bbe95ec398",
"db_currency_id": "219eed2c-fece-48ed-9b71-10eef3bcda0e",
"db_language_id": "1559ce17-6021-4873-9353-3fe3e76e4481",
"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-08-07T05:37:11.0047214+00:00"
},
"modified_dateutc": "2026-08-07T05:37:11.0047214+00:00"
},
"equipment_family_id": "72b41a2d-4c11-47c4-b765-07eeccba6027",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "902eaaca-3a19-46fb-851e-629a3c0f9e21",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2610adb2-6993-454b-95fd-f0d10f591a6f",
"_parent_code": "sample string 6",
"sales_organization_id": "37dc71ab-e603-4d31-b15b-090deeb39eee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c8f9ae81-734d-48dc-9c85-8d10f64e3e43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c2db0e4-90e1-42fb-a678-f0bbe95ec398",
"db_currency_id": "219eed2c-fece-48ed-9b71-10eef3bcda0e",
"db_language_id": "1559ce17-6021-4873-9353-3fe3e76e4481",
"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-08-07T05:37:11.0047214+00:00"
},
"modified_dateutc": "2026-08-07T05:37:11.0047214+00:00"
},
"date_in_production_since": "2026-08-07T05:37:11.0047214+00:00",
"date_out_of_production_since": "2026-08-07T05:37:11.0047214+00:00",
"date_end_support": "2026-08-07T05:37:11.0047214+00:00",
"sales_organization_id": "8f1a719e-ef39-4716-a54f-a032f53f2074",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c8f9ae81-734d-48dc-9c85-8d10f64e3e43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c2db0e4-90e1-42fb-a678-f0bbe95ec398",
"db_currency_id": "219eed2c-fece-48ed-9b71-10eef3bcda0e",
"db_language_id": "1559ce17-6021-4873-9353-3fe3e76e4481",
"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-08-07T05:37:11.0047214+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-08-07T05:37:11.0047214+00:00"
},
"project_status_id": "d69f930c-b6a6-4808-95c0-0d7e4c8586bf",
"project_status_code": "sample string 10",
"project_status": {
"id": "5fd82833-82e6-41de-89ce-4062f2078332",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f5890a1a-dadf-4ef3-be90-bf9a6e7a3e7a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c8f9ae81-734d-48dc-9c85-8d10f64e3e43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c2db0e4-90e1-42fb-a678-f0bbe95ec398",
"db_currency_id": "219eed2c-fece-48ed-9b71-10eef3bcda0e",
"db_language_id": "1559ce17-6021-4873-9353-3fe3e76e4481",
"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-08-07T05:37:11.0047214+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-07T05:37:11.0047214+00:00"
},
"company_id": "61e61d3f-2f18-4bfc-8f4e-21653299da4f",
"company_code": "sample string 12",
"db_address_id": "c698ddca-f0fc-408e-aee7-284e61feee41",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3ef5e099-baaf-4f59-af70-9a3fb94ffb04",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a47cfd39-6b6b-4b40-868e-89ee638f4678",
"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-08-07T05:37:11.0047214+00:00",
"date_create": "2026-08-07T05:37:11.0047214+00:00",
"date_update": "2026-08-07T05:37:11.0047214+00:00",
"updated_by_user_id": "d23b904a-5151-4f4d-a858-afe8d4f40cbc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-07T05:37:11.0047214+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-08-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-07T05:37:11.0047214+00:00",
"date_last_job": "2026-08-07T05:37:11.0047214+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-07T05:37:11.0047214+00:00",
"modified_dateutc": "2026-08-07T05:37:11.0047214+00:00",
"is_mobile_installation": true
},
"job_type_id": "720de610-3386-4d23-a3c8-c9ae604b2530",
"job_type_code": "sample string 7",
"job_type": {
"id": "0c9a6032-6a04-458f-b784-ccbb1642b793",
"name": "sample string 2",
"sales_organization_id": "a4df8048-dd8c-4afc-930f-408752ba0645",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-07T05:37:11.0047214+00:00",
"code": "sample string 7"
},
"job_priority_id": "cd17acde-0a67-4397-9cd3-755c657e0ea2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a06c7dcb-8669-48b7-aff6-b477591c63e3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0e2ee495-44a8-4644-ac6f-307efbe4ce5d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c8f9ae81-734d-48dc-9c85-8d10f64e3e43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c2db0e4-90e1-42fb-a678-f0bbe95ec398",
"db_currency_id": "219eed2c-fece-48ed-9b71-10eef3bcda0e",
"db_language_id": "1559ce17-6021-4873-9353-3fe3e76e4481",
"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-08-07T05:37:11.0047214+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-07T05:37:11.0047214+00:00"
},
"job_status_id": "15713f9c-22ad-4061-bd7b-344eefe5948f",
"job_status_code": "sample string 11",
"db_address_id": "21757558-9541-4635-bf4a-5855e7e414bd",
"contact_id": "c535d271-1233-4fa0-9bda-3371dcb0c75d",
"requested_by_company_id": "2e87e8a0-aa8c-42f8-9fa6-33746716f2c3",
"requested_by_contact_id": "ddca9399-b236-4a0b-9413-b072aaeceecc",
"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-08-07T05:37:11.0047214+00:00",
"due_date": "2026-08-07T05:37:11.0047214+00:00",
"date_create": "2026-08-07T05:37:11.0047214+00:00",
"date_update": "2026-08-07T05:37:11.0047214+00:00",
"date_closed": "2026-08-07T05:37:11.0047214+00:00",
"suggested_user_id": "fefa5d37-94dc-4afa-9e84-1fc3ede50817",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2ddabe35-e0ae-47f2-a644-444b13c73250",
"db_language_id": "fed1e082-2089-4925-a82f-ac3d6156da0b",
"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-08-07T05:37:11.0047214+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "82ade099-605f-4861-baff-f6f5a62fb03e",
"sales_organization": {
"id": "c8f9ae81-734d-48dc-9c85-8d10f64e3e43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c2db0e4-90e1-42fb-a678-f0bbe95ec398",
"db_currency_id": "219eed2c-fece-48ed-9b71-10eef3bcda0e",
"db_language_id": "1559ce17-6021-4873-9353-3fe3e76e4481",
"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-08-07T05:37:11.0047214+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "804adf58-28d5-4a64-9b2f-d2b2df91bfc1",
"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": "59fd5fd6-0cc3-4a58-9ba2-e3088cff3c77",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-07T05:37:11.0047214+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d35709fa-8986-4113-9378-4fd0023855f9"
},
"suggested_date_start": "2026-08-07T05:37:11.0047214+00:00",
"skill_id": "9b8a4628-066e-4ab7-b4ea-fe139871b3e1",
"skill_code": "sample string 32",
"skill": {
"id": "ca9857fd-196c-40ca-bd81-11481425dabd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9fd08ce3-c9ca-4869-a065-113a5ab5766c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c8f9ae81-734d-48dc-9c85-8d10f64e3e43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c2db0e4-90e1-42fb-a678-f0bbe95ec398",
"db_currency_id": "219eed2c-fece-48ed-9b71-10eef3bcda0e",
"db_language_id": "1559ce17-6021-4873-9353-3fe3e76e4481",
"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-08-07T05:37:11.0047214+00:00"
},
"modified_dateutc": "2026-08-07T05:37:11.0047214+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7ca9a5cc-97cc-4f9a-9eb8-0548e58ee3ee",
"date_reported_by_company": "2026-08-07T05:37:11.0047214+00:00",
"id2": 36,
"company_id": "78ab2cb4-a1b7-49e3-b138-666f9a8a783f",
"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": "75549563-50ec-4128-be90-3f2c25e76687",
"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-08-07T05:37:11.0047214+00:00"
},
"work_instruction_details_id": "13a4b5ed-e60d-4cc4-9c5d-afc4bf82cdb8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c1162521-49e8-40e5-92f4-4fa744b3e43b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "11dc2099-69a5-4f84-a137-0ccaa1cf79c6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-07T05:37:11.0047214+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": "2357e351-beb2-4f94-8d33-56d21511068d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-07T05:37:11.0047214+00:00"
}