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": "830d7150-660a-46f9-a3a2-718d2222a643",
"jobs_id": "c5588ae4-c0ed-41de-bc1a-46840fa69b51",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "627085ab-0079-446f-8cf3-8ceeea17bd04",
"_parent_id": "9fa397ed-886e-4ebb-9dbf-3e54d282d23d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a5fd7270-b382-414b-816c-77a1b5d9da63",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5375ee73-30e0-44df-a9a9-97555f296fc6",
"_parent_id": "629afc2c-05a0-43cb-b1dc-7dea73d4e617",
"root_parent_id": "6fbdddc6-93a2-4ff8-8283-0fac42eb51f2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d983ece6-72da-48e5-8585-1c4fc6a4600d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1b3026f5-17f2-49e2-965c-3a809f265277",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7e7bd2f9-08c2-445b-a99a-b7a79f8dc4d6",
"_parent_code": "sample string 6",
"sales_organization_id": "51734d38-bd62-4d10-afab-6dcf653a17ec",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0e36309c-8c8e-48c4-af90-1a816184f62f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8f2cc80a-8a36-421c-a194-707dcb9f481f",
"db_currency_id": "b526e18a-351a-49fb-83b1-b40673418441",
"db_language_id": "d7fa7737-b309-40ce-ae9d-b7155797abed",
"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-02-06T16:00:32.3307807+00:00"
},
"modified_dateutc": "2026-02-06T16:00:32.3307807+00:00"
},
"equipment_model_id": "bcdcacae-f4cf-4d18-bf19-4f290fe0f03f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0582bc70-895d-4014-a73f-a078f8bb04b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0b4a62b9-0e3d-4c0e-bf07-3c23c26311b8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "835ab7bf-bc5b-4969-90a3-35b6fff24809",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "311f4677-04d2-4c9f-b8fa-086b98c71ad9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0e36309c-8c8e-48c4-af90-1a816184f62f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8f2cc80a-8a36-421c-a194-707dcb9f481f",
"db_currency_id": "b526e18a-351a-49fb-83b1-b40673418441",
"db_language_id": "d7fa7737-b309-40ce-ae9d-b7155797abed",
"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-02-06T16:00:32.3307807+00:00"
},
"modified_dateutc": "2026-02-06T16:00:32.3307807+00:00"
},
"equipment_family_id": "e3794bab-1c1b-4413-81e4-8285e0a212a5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1b3026f5-17f2-49e2-965c-3a809f265277",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7e7bd2f9-08c2-445b-a99a-b7a79f8dc4d6",
"_parent_code": "sample string 6",
"sales_organization_id": "51734d38-bd62-4d10-afab-6dcf653a17ec",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0e36309c-8c8e-48c4-af90-1a816184f62f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8f2cc80a-8a36-421c-a194-707dcb9f481f",
"db_currency_id": "b526e18a-351a-49fb-83b1-b40673418441",
"db_language_id": "d7fa7737-b309-40ce-ae9d-b7155797abed",
"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-02-06T16:00:32.3307807+00:00"
},
"modified_dateutc": "2026-02-06T16:00:32.3307807+00:00"
},
"date_in_production_since": "2026-02-06T16:00:32.3307807+00:00",
"date_out_of_production_since": "2026-02-06T16:00:32.3307807+00:00",
"date_end_support": "2026-02-06T16:00:32.3307807+00:00",
"sales_organization_id": "ed3419e5-8c3d-4569-a4d8-0fdfe752ff4b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0e36309c-8c8e-48c4-af90-1a816184f62f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8f2cc80a-8a36-421c-a194-707dcb9f481f",
"db_currency_id": "b526e18a-351a-49fb-83b1-b40673418441",
"db_language_id": "d7fa7737-b309-40ce-ae9d-b7155797abed",
"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-02-06T16:00:32.3307807+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-02-06T16:00:32.3307807+00:00"
},
"project_status_id": "2e9615b8-0ba5-4ad0-bcf9-14fa5f56aeb1",
"project_status_code": "sample string 10",
"project_status": {
"id": "b9d2aad4-e399-401d-aaa5-b1a4967fa5ad",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "207234f0-2ea0-4bca-a987-d43eafa73b15",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0e36309c-8c8e-48c4-af90-1a816184f62f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8f2cc80a-8a36-421c-a194-707dcb9f481f",
"db_currency_id": "b526e18a-351a-49fb-83b1-b40673418441",
"db_language_id": "d7fa7737-b309-40ce-ae9d-b7155797abed",
"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-02-06T16:00:32.3307807+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-06T16:00:32.3307807+00:00"
},
"company_id": "34bd6990-b9be-43f0-9b93-f14657d912e3",
"company_code": "sample string 12",
"db_address_id": "cee5682c-dbc3-4462-9e06-9a04d45faddd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8590797e-9c70-4d77-a26d-8ebeb28d1584",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "62abbf76-6e96-4064-a706-404acf4a8b65",
"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-02-06T16:00:32.3307807+00:00",
"date_create": "2026-02-06T16:00:32.3307807+00:00",
"date_update": "2026-02-06T16:00:32.3307807+00:00",
"updated_by_user_id": "88fc38f7-a3ae-476d-8bad-6d9c98daf638",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-06T16:00:32.3307807+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-02-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-06T16:00:32.3307807+00:00",
"date_last_job": "2026-02-06T16:00:32.3307807+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-06T16:00:32.3307807+00:00",
"modified_dateutc": "2026-02-06T16:00:32.3307807+00:00",
"is_mobile_installation": true
},
"job_type_id": "84687eb1-b75d-427f-891c-cf984572ef16",
"job_type_code": "sample string 7",
"job_type": {
"id": "70ba4399-d953-4e44-92c5-e53a938f08ab",
"name": "sample string 2",
"sales_organization_id": "38bb715b-7c68-4d29-8998-16294a468ea3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-06T16:00:32.3307807+00:00",
"code": "sample string 7"
},
"job_priority_id": "4ea6ace7-1fab-42a4-914c-c62f704f5d57",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "21e4b2e3-b0b1-47be-8571-2e38faa5abae",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "25f163e6-97d3-4a9c-a178-453b31da167c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0e36309c-8c8e-48c4-af90-1a816184f62f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8f2cc80a-8a36-421c-a194-707dcb9f481f",
"db_currency_id": "b526e18a-351a-49fb-83b1-b40673418441",
"db_language_id": "d7fa7737-b309-40ce-ae9d-b7155797abed",
"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-02-06T16:00:32.3307807+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-06T16:00:32.3307807+00:00"
},
"job_status_id": "94098a4e-fd25-4af0-b3b4-c9282fc86fb3",
"job_status_code": "sample string 11",
"db_address_id": "77048d6d-7b3b-40b9-8d1f-fa3ee9f3a641",
"contact_id": "779556e8-c194-4749-a51f-213333f23811",
"requested_by_company_id": "d0a34b0c-fe87-4ff5-9aed-d2bf20c21968",
"requested_by_contact_id": "07bbe41e-eada-4bc9-a09e-6947cebc8557",
"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-02-06T16:00:32.3307807+00:00",
"due_date": "2026-02-06T16:00:32.3307807+00:00",
"date_create": "2026-02-06T16:00:32.3307807+00:00",
"date_update": "2026-02-06T16:00:32.3307807+00:00",
"date_closed": "2026-02-06T16:00:32.3307807+00:00",
"suggested_user_id": "cb5c59d2-2739-4596-82d3-977ce689bc2d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ad191601-3eea-4bad-a671-ab500800220b",
"db_language_id": "0ab00856-dcb3-4636-ac11-4a90aeed00d5",
"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-02-06T16:00:32.3307807+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f61f1d61-a34c-4a8b-b7ef-2db99e2ce3b5",
"sales_organization": {
"id": "0e36309c-8c8e-48c4-af90-1a816184f62f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8f2cc80a-8a36-421c-a194-707dcb9f481f",
"db_currency_id": "b526e18a-351a-49fb-83b1-b40673418441",
"db_language_id": "d7fa7737-b309-40ce-ae9d-b7155797abed",
"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-02-06T16:00:32.3307807+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e00e2357-12e2-4bcb-b6ea-8501b47ea143",
"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": "2198cf81-ba0b-4e69-8209-577107e1b57b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-06T16:00:32.3307807+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ecad9a23-209c-444e-a0e7-40fb65e985e7"
},
"suggested_date_start": "2026-02-06T16:00:32.3307807+00:00",
"skill_id": "922846e6-49d6-4252-94eb-77b51c2f305c",
"skill_code": "sample string 32",
"skill": {
"id": "3189077d-ea45-410b-b37b-7c6800808cfd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7d3d921d-51dc-46d7-ae71-b824c2487f93",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0e36309c-8c8e-48c4-af90-1a816184f62f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8f2cc80a-8a36-421c-a194-707dcb9f481f",
"db_currency_id": "b526e18a-351a-49fb-83b1-b40673418441",
"db_language_id": "d7fa7737-b309-40ce-ae9d-b7155797abed",
"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-02-06T16:00:32.3307807+00:00"
},
"modified_dateutc": "2026-02-06T16:00:32.3307807+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ff627c5b-28e2-4ee9-a8f6-9fd8a5e408e5",
"date_reported_by_company": "2026-02-06T16:00:32.3307807+00:00",
"id2": 36,
"company_id": "c65fc17a-bef7-4a14-ba9d-4b693eb1a64c",
"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": "a41dd1ef-e3ec-47b7-af8d-9bfde9cc5aa7",
"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-02-06T16:00:32.3307807+00:00"
},
"work_instruction_details_id": "0a338b38-06fb-4477-a39c-86133337950a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d738e93e-9c75-46dc-aa1a-69334fdc8560",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cd9487af-fb45-4936-addb-698a2239ec72",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-06T16:00:32.3307807+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": "a00fb454-dfdc-4ed5-be8a-441474b645e0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-06T16:00:32.3307807+00:00"
}