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": "452f15fa-9bcc-41e2-af6a-50fead71846e",
"jobs_id": "6d888809-c656-4f2a-8c6f-0405024ed1ae",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e9e03699-9053-42db-b7f4-3a853cb3b37c",
"_parent_id": "9889890f-c5f1-4666-9bea-32dfb6d742ca",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "39f5143e-811c-4106-b260-672d968eb687",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f47f97a4-9e3b-408f-9883-8a6d47c3bb74",
"_parent_id": "993d97ee-e79d-4de6-a088-a99c8e9da0f6",
"root_parent_id": "e2ec86cb-6d42-415f-8901-38855edeaadf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "19670d71-fba6-43c0-a43e-0a42ed8af936",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f23adde0-e7c4-4c20-b083-dff0eed43d6f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "763da12b-be46-4b4f-85e0-1cd5e0907d8d",
"_parent_code": "sample string 6",
"sales_organization_id": "6094bc3a-fee9-4638-8598-1f1bdde33351",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d95866a8-0045-416f-aac1-9a43882be656",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "667dd1b2-aa26-4e12-b010-e15026e01ff5",
"db_currency_id": "172ff133-9bfa-48b1-a30b-72e1a4af89ab",
"db_language_id": "00969db2-f358-438d-8fea-72273e6bd8e2",
"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-07-12T06:27:08.6467873+00:00"
},
"modified_dateutc": "2026-07-12T06:27:08.6467873+00:00"
},
"equipment_model_id": "680ea120-bce0-4b0b-97e8-0b948eff8194",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c4326201-ddde-4537-8514-8db131ed7475",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "08a6b7f7-4f34-4ba9-933e-3848f2d48726",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "03b514f4-cd38-439b-a524-eae9ef604611",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7781e11e-1048-4383-a155-5e07b4e12aab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d95866a8-0045-416f-aac1-9a43882be656",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "667dd1b2-aa26-4e12-b010-e15026e01ff5",
"db_currency_id": "172ff133-9bfa-48b1-a30b-72e1a4af89ab",
"db_language_id": "00969db2-f358-438d-8fea-72273e6bd8e2",
"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-07-12T06:27:08.6467873+00:00"
},
"modified_dateutc": "2026-07-12T06:27:08.6467873+00:00"
},
"equipment_family_id": "2638f6b9-8504-4a46-aade-ff29d75dab59",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f23adde0-e7c4-4c20-b083-dff0eed43d6f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "763da12b-be46-4b4f-85e0-1cd5e0907d8d",
"_parent_code": "sample string 6",
"sales_organization_id": "6094bc3a-fee9-4638-8598-1f1bdde33351",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d95866a8-0045-416f-aac1-9a43882be656",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "667dd1b2-aa26-4e12-b010-e15026e01ff5",
"db_currency_id": "172ff133-9bfa-48b1-a30b-72e1a4af89ab",
"db_language_id": "00969db2-f358-438d-8fea-72273e6bd8e2",
"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-07-12T06:27:08.6467873+00:00"
},
"modified_dateutc": "2026-07-12T06:27:08.6467873+00:00"
},
"date_in_production_since": "2026-07-12T06:27:08.6467873+00:00",
"date_out_of_production_since": "2026-07-12T06:27:08.6467873+00:00",
"date_end_support": "2026-07-12T06:27:08.6467873+00:00",
"sales_organization_id": "4c8623f7-2ad1-4fea-84c9-c806b67dd675",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d95866a8-0045-416f-aac1-9a43882be656",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "667dd1b2-aa26-4e12-b010-e15026e01ff5",
"db_currency_id": "172ff133-9bfa-48b1-a30b-72e1a4af89ab",
"db_language_id": "00969db2-f358-438d-8fea-72273e6bd8e2",
"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-07-12T06:27:08.6467873+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-07-12T06:27:08.6467873+00:00"
},
"project_status_id": "b566f5ec-7bf0-4b4a-91f2-bd8d1879c319",
"project_status_code": "sample string 10",
"project_status": {
"id": "53fd0349-3895-4129-b3f5-722399b7a72b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "84c04657-d84c-42eb-9bce-2003a661b473",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d95866a8-0045-416f-aac1-9a43882be656",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "667dd1b2-aa26-4e12-b010-e15026e01ff5",
"db_currency_id": "172ff133-9bfa-48b1-a30b-72e1a4af89ab",
"db_language_id": "00969db2-f358-438d-8fea-72273e6bd8e2",
"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-07-12T06:27:08.6467873+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-12T06:27:08.6467873+00:00"
},
"company_id": "e32592cd-ab60-4ab7-b2e0-ffb35e6674a7",
"company_code": "sample string 12",
"db_address_id": "58603348-c369-4e1d-a63e-6ab814979dd6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7b5b42f5-a961-4d71-9244-e09c56bdee5a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d7becbbe-447a-4805-b1f3-74cfefa8c526",
"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-07-12T06:27:08.6467873+00:00",
"date_create": "2026-07-12T06:27:08.6467873+00:00",
"date_update": "2026-07-12T06:27:08.6467873+00:00",
"updated_by_user_id": "dad7eb1a-c210-4c15-8428-e08cd4826377",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-12T06:27:08.6467873+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-07-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-12T06:27:08.6467873+00:00",
"date_last_job": "2026-07-12T06:27:08.6467873+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-12T06:27:08.6467873+00:00",
"modified_dateutc": "2026-07-12T06:27:08.6467873+00:00",
"is_mobile_installation": true
},
"job_type_id": "8dc60961-ed65-411e-b90b-fed8d5f6c7a4",
"job_type_code": "sample string 7",
"job_type": {
"id": "a60b3418-2e73-48dc-b6ca-98d340272c8e",
"name": "sample string 2",
"sales_organization_id": "0e9c08f1-5b70-4911-89db-04c6ac2a7880",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-12T06:27:08.6467873+00:00",
"code": "sample string 7"
},
"job_priority_id": "ca18aa3c-b2b1-4ec9-866e-9667cddbd9b1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "95c06155-8788-4387-bf76-1c4828bd89a6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "96f99a35-a1e4-43cc-b067-5d3fe6a0c645",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d95866a8-0045-416f-aac1-9a43882be656",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "667dd1b2-aa26-4e12-b010-e15026e01ff5",
"db_currency_id": "172ff133-9bfa-48b1-a30b-72e1a4af89ab",
"db_language_id": "00969db2-f358-438d-8fea-72273e6bd8e2",
"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-07-12T06:27:08.6467873+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-12T06:27:08.6467873+00:00"
},
"job_status_id": "f4ae7319-ae99-4ed5-b18d-c9aa1f0cec8a",
"job_status_code": "sample string 11",
"db_address_id": "00ad87e5-c0b5-4537-bfdd-a6a5d2d07d42",
"contact_id": "22b7b02f-e3d9-415f-bd10-26284f502386",
"requested_by_company_id": "4c3d732f-31f0-4b00-8a87-c07c04321240",
"requested_by_contact_id": "10e89412-af73-49ff-99cf-2135a9ed6dce",
"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-07-12T06:27:08.6467873+00:00",
"due_date": "2026-07-12T06:27:08.6467873+00:00",
"date_create": "2026-07-12T06:27:08.6467873+00:00",
"date_update": "2026-07-12T06:27:08.6467873+00:00",
"date_closed": "2026-07-12T06:27:08.6467873+00:00",
"suggested_user_id": "b8a3e569-8ecb-4e53-8afa-e17d8fcf6554",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "596acd2d-428a-498d-9ee8-3ace3847f6eb",
"db_language_id": "92e32a71-3bdd-4cd9-bc41-aa85ef52f843",
"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-07-12T06:27:08.662413+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "74192985-3d95-4c1c-90d0-230bc043174a",
"sales_organization": {
"id": "d95866a8-0045-416f-aac1-9a43882be656",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "667dd1b2-aa26-4e12-b010-e15026e01ff5",
"db_currency_id": "172ff133-9bfa-48b1-a30b-72e1a4af89ab",
"db_language_id": "00969db2-f358-438d-8fea-72273e6bd8e2",
"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-07-12T06:27:08.6467873+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3c1607ba-a27d-46cb-a7c1-9461da2df3d0",
"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": "0d2b1e1e-479e-4197-ae0f-a5d846ce0d16",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-12T06:27:08.662413+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6176b630-3a97-473e-a04a-1c995a555b00"
},
"suggested_date_start": "2026-07-12T06:27:08.662413+00:00",
"skill_id": "27e45212-5f4d-4435-854a-ee25c5c22ca9",
"skill_code": "sample string 32",
"skill": {
"id": "131a1cda-c4c2-42fe-8b04-785edf5fb9ea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2a27d454-9969-4e6c-86ae-369ce0d6bb40",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d95866a8-0045-416f-aac1-9a43882be656",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "667dd1b2-aa26-4e12-b010-e15026e01ff5",
"db_currency_id": "172ff133-9bfa-48b1-a30b-72e1a4af89ab",
"db_language_id": "00969db2-f358-438d-8fea-72273e6bd8e2",
"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-07-12T06:27:08.6467873+00:00"
},
"modified_dateutc": "2026-07-12T06:27:08.662413+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5e6e49ba-ac37-4d36-9188-149a57b743d2",
"date_reported_by_company": "2026-07-12T06:27:08.662413+00:00",
"id2": 36,
"company_id": "6bcf210e-7d9b-4dc7-bb82-0c3f55e96b40",
"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": "55837022-1410-4df5-8a59-b39bf0f01c68",
"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-07-12T06:27:08.662413+00:00"
},
"work_instruction_details_id": "af5d6853-3e7a-456a-b178-167001b7e253",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1f98260e-fc4b-46ad-a683-7c630dc8603f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "91c76777-ee5a-469d-8da0-acd93f44f59e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-12T06:27:08.662413+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": "2698a6a5-8fad-4805-8c6c-7bf058aee81d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-12T06:27:08.662413+00:00"
}