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": "d97a2f1a-2dad-42a0-891e-c5d8fae7fce8",
"jobs_id": "90a3ea0a-c220-4b6b-82bd-c3cb55671a7b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c0c2fc8f-f1e2-484b-a349-3536e5170010",
"_parent_id": "8ed2fb80-a139-45f8-8592-37899e79ca7e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "eb166886-f655-4301-b5eb-f27d2cd8c8a8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4a88cf1f-94bf-4821-8509-a6b1fa2f08d4",
"_parent_id": "b2965c0d-dbbc-4c12-b412-cdb6f947cf03",
"root_parent_id": "4e4f34be-cda1-4978-9c8f-210991f07f2a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "06b1ee58-a78b-45a8-85a3-6063e020ebe7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b47c1802-ca4f-4c1f-9f1c-f1e72817366f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e2f3cd97-6bcc-4009-b7df-31392806bbaf",
"_parent_code": "sample string 6",
"sales_organization_id": "49777add-0651-480e-b232-db2dabd1a796",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "043e4d7e-ba2f-4284-8496-3b305b4f85fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d46fe610-ab8b-488f-ae7f-2eb2229ace22",
"db_currency_id": "cb73a3d3-c611-4515-9715-b331956112f2",
"db_language_id": "5031a904-5ed1-4218-b2ec-b29f15ac5f55",
"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-10-01T06:37:24.6703453+00:00"
},
"modified_dateutc": "2025-10-01T06:37:24.6703453+00:00"
},
"equipment_model_id": "0874c0d3-5670-4453-83c7-50272e27b408",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "31b550c5-4a56-46fa-b0b0-e350207f3e02",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8578b5c7-e1cd-4974-857b-2ee139b0fef6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b3434e3e-7d64-46c5-b161-47f32cf40907",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fdf6ec6d-7298-4d9a-bdfe-37efc039dda2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "043e4d7e-ba2f-4284-8496-3b305b4f85fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d46fe610-ab8b-488f-ae7f-2eb2229ace22",
"db_currency_id": "cb73a3d3-c611-4515-9715-b331956112f2",
"db_language_id": "5031a904-5ed1-4218-b2ec-b29f15ac5f55",
"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-10-01T06:37:24.6703453+00:00"
},
"modified_dateutc": "2025-10-01T06:37:24.6703453+00:00"
},
"equipment_family_id": "80f76791-9917-4982-b895-c21ff770053a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b47c1802-ca4f-4c1f-9f1c-f1e72817366f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e2f3cd97-6bcc-4009-b7df-31392806bbaf",
"_parent_code": "sample string 6",
"sales_organization_id": "49777add-0651-480e-b232-db2dabd1a796",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "043e4d7e-ba2f-4284-8496-3b305b4f85fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d46fe610-ab8b-488f-ae7f-2eb2229ace22",
"db_currency_id": "cb73a3d3-c611-4515-9715-b331956112f2",
"db_language_id": "5031a904-5ed1-4218-b2ec-b29f15ac5f55",
"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-10-01T06:37:24.6703453+00:00"
},
"modified_dateutc": "2025-10-01T06:37:24.6703453+00:00"
},
"date_in_production_since": "2025-10-01T06:37:24.6703453+00:00",
"date_out_of_production_since": "2025-10-01T06:37:24.6703453+00:00",
"date_end_support": "2025-10-01T06:37:24.6703453+00:00",
"sales_organization_id": "b4e14f4d-b1e4-4633-850c-53de23403565",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "043e4d7e-ba2f-4284-8496-3b305b4f85fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d46fe610-ab8b-488f-ae7f-2eb2229ace22",
"db_currency_id": "cb73a3d3-c611-4515-9715-b331956112f2",
"db_language_id": "5031a904-5ed1-4218-b2ec-b29f15ac5f55",
"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-10-01T06:37:24.6703453+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-10-01T06:37:24.6703453+00:00"
},
"project_status_id": "0a498d73-0840-48f2-a2e8-ee1b554d0524",
"project_status_code": "sample string 10",
"project_status": {
"id": "e831a12f-d0bc-42b3-a1a2-209a0d5c69b8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f54beb30-7afc-4f9d-b0e1-11242b2621d3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "043e4d7e-ba2f-4284-8496-3b305b4f85fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d46fe610-ab8b-488f-ae7f-2eb2229ace22",
"db_currency_id": "cb73a3d3-c611-4515-9715-b331956112f2",
"db_language_id": "5031a904-5ed1-4218-b2ec-b29f15ac5f55",
"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-10-01T06:37:24.6703453+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-01T06:37:24.6703453+00:00"
},
"company_id": "874d4198-d35e-4136-a0c0-417eca524d82",
"company_code": "sample string 12",
"db_address_id": "b657fb3e-888a-4fd3-81f0-8b1e63b5ae7e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "03fc2115-0a81-453c-9b7b-d53d92ffcbb8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3c535758-3e5e-41d2-bb41-b4107c267f7a",
"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-10-01T06:37:24.6703453+00:00",
"date_create": "2025-10-01T06:37:24.6703453+00:00",
"date_update": "2025-10-01T06:37:24.6703453+00:00",
"updated_by_user_id": "3ea540e1-9f23-4da7-a301-71d584500c15",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-01T06:37:24.6703453+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-10-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-01T06:37:24.6703453+00:00",
"date_last_job": "2025-10-01T06:37:24.6703453+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-01T06:37:24.6703453+00:00",
"modified_dateutc": "2025-10-01T06:37:24.6703453+00:00",
"is_mobile_installation": true
},
"job_type_id": "5f14bde5-de1c-408f-a38f-9635d6e3e56d",
"job_type_code": "sample string 7",
"job_type": {
"id": "7e7ea57a-fcf0-46e8-a365-e6286007eb1b",
"name": "sample string 2",
"sales_organization_id": "7b14aae6-9b22-47a2-b637-f67ba2ec4680",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-01T06:37:24.6703453+00:00",
"code": "sample string 7"
},
"job_priority_id": "4db64285-1ec8-4497-b404-b50824028b48",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1035b2ca-f3d6-4f24-bc3c-d8c5b36ca95b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3c5febb5-3dcb-4aef-b31d-6727b47512c4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "043e4d7e-ba2f-4284-8496-3b305b4f85fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d46fe610-ab8b-488f-ae7f-2eb2229ace22",
"db_currency_id": "cb73a3d3-c611-4515-9715-b331956112f2",
"db_language_id": "5031a904-5ed1-4218-b2ec-b29f15ac5f55",
"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-10-01T06:37:24.6703453+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-01T06:37:24.6703453+00:00"
},
"job_status_id": "efe092d3-a3c9-4523-904f-5dae1b0a918b",
"job_status_code": "sample string 11",
"db_address_id": "bf911e02-018b-4d32-998e-24de211b5253",
"contact_id": "7fdf13e8-3ee3-408d-83a9-73f4584e01a2",
"requested_by_company_id": "90ad3c61-12c4-404d-beb4-686e0eedd36a",
"requested_by_contact_id": "df9beff9-bea1-4c06-820d-319566df6af9",
"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-10-01T06:37:24.6703453+00:00",
"due_date": "2025-10-01T06:37:24.6703453+00:00",
"date_create": "2025-10-01T06:37:24.6703453+00:00",
"date_update": "2025-10-01T06:37:24.6703453+00:00",
"date_closed": "2025-10-01T06:37:24.6703453+00:00",
"suggested_user_id": "83884b1f-6a3c-4c9e-bffe-a86ce07701cd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d457a97e-0447-4737-8618-4d7843df285c",
"db_language_id": "772a02b3-4716-45ce-bcfa-9ae259b33f59",
"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-10-01T06:37:24.6703453+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a1b91fb1-2bce-4ee3-a98d-e6199f649d53",
"sales_organization": {
"id": "043e4d7e-ba2f-4284-8496-3b305b4f85fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d46fe610-ab8b-488f-ae7f-2eb2229ace22",
"db_currency_id": "cb73a3d3-c611-4515-9715-b331956112f2",
"db_language_id": "5031a904-5ed1-4218-b2ec-b29f15ac5f55",
"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-10-01T06:37:24.6703453+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d96c721c-34cb-46d9-8e37-3dc75ab7c267",
"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": "1365714b-e937-44c9-8cb9-4dc032aa1666",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-01T06:37:24.6703453+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4fcefe28-2924-4ccf-82e3-00c28ed79654"
},
"suggested_date_start": "2025-10-01T06:37:24.6703453+00:00",
"skill_id": "5dff5bb6-11bc-4c92-88a2-75d24480a379",
"skill_code": "sample string 32",
"skill": {
"id": "a5c90202-c8b5-45cf-ab6e-8fee22ba8df9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c210ef62-e97e-4397-b040-2a17f937000f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "043e4d7e-ba2f-4284-8496-3b305b4f85fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d46fe610-ab8b-488f-ae7f-2eb2229ace22",
"db_currency_id": "cb73a3d3-c611-4515-9715-b331956112f2",
"db_language_id": "5031a904-5ed1-4218-b2ec-b29f15ac5f55",
"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-10-01T06:37:24.6703453+00:00"
},
"modified_dateutc": "2025-10-01T06:37:24.6703453+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d6d8ab6a-7bf0-4d02-a95b-8353adb799d0",
"date_reported_by_company": "2025-10-01T06:37:24.6703453+00:00",
"id2": 36,
"company_id": "7d5fa06f-bdd7-4e1a-8536-f5b873be5c1b",
"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": "3a658bdc-b30f-421d-9bbb-d09ece7603ae",
"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-10-01T06:37:24.6703453+00:00"
},
"work_instruction_details_id": "b9af1a14-45cd-40be-bf11-3458705617ca",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "59948008-15fe-49a8-a66b-d18f439bc740",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4b39bd37-4341-4c63-9e20-6f0bf65b1db3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-01T06:37:24.6703453+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": "742283a7-6f60-460d-8e29-0392f2d081db",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-01T06:37:24.6703453+00:00"
}