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": "a5bb8b99-b1c1-4628-a4e4-f2cab292fb4a",
"jobs_id": "70d0b9d2-afe5-4003-bc8b-1e51899a333e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "83312286-8f67-4fb0-8324-e44a00e423c2",
"_parent_id": "951fce6c-683b-4b9c-b09e-bd9f7a0d968b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e65fcf2a-f647-4192-bf58-e1cef1595d21",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f09a1d3f-000a-40de-bade-637338e4766c",
"_parent_id": "a05e568c-896b-46af-afe6-dfc846a6fac9",
"root_parent_id": "771437b2-c9ec-4fca-bbc8-1e5127d036b5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c9d029fe-6d9a-459e-a7a5-8c1e1b37f5f9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c2174ec8-55e0-4b7e-b8fc-9dd0acb4dfe1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6221b8ba-4975-46e5-b925-4e0f26bd1faf",
"_parent_code": "sample string 6",
"sales_organization_id": "a814d1af-3c76-4222-82e1-6aef19b72083",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2290678a-eea6-4950-b021-875616328bc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77193032-e951-489e-b1de-19f2a24249d7",
"db_currency_id": "18a8c7eb-42b8-4a3a-a682-93a4fd135479",
"db_language_id": "6e9de665-495a-4cf5-8493-2ff39dd83146",
"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-10-09T07:42:06.5772918+00:00"
},
"modified_dateutc": "2026-10-09T07:42:06.5973413+00:00"
},
"equipment_model_id": "532a364a-c8fb-44a9-8b7c-139046fdeb39",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a03fb1c8-9483-47b4-b479-5dfd22e2c22c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3c870f93-25ab-4533-a901-1c7d7948b7d2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "560dc85a-1413-4c6b-8504-53d753e2a950",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "498c215e-b7f1-4063-b04e-4188f39a8009",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2290678a-eea6-4950-b021-875616328bc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77193032-e951-489e-b1de-19f2a24249d7",
"db_currency_id": "18a8c7eb-42b8-4a3a-a682-93a4fd135479",
"db_language_id": "6e9de665-495a-4cf5-8493-2ff39dd83146",
"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-10-09T07:42:06.5772918+00:00"
},
"modified_dateutc": "2026-10-09T07:42:06.5973413+00:00"
},
"equipment_family_id": "f887788e-179d-4ce5-9c8e-4c194aa38d84",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c2174ec8-55e0-4b7e-b8fc-9dd0acb4dfe1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6221b8ba-4975-46e5-b925-4e0f26bd1faf",
"_parent_code": "sample string 6",
"sales_organization_id": "a814d1af-3c76-4222-82e1-6aef19b72083",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2290678a-eea6-4950-b021-875616328bc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77193032-e951-489e-b1de-19f2a24249d7",
"db_currency_id": "18a8c7eb-42b8-4a3a-a682-93a4fd135479",
"db_language_id": "6e9de665-495a-4cf5-8493-2ff39dd83146",
"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-10-09T07:42:06.5772918+00:00"
},
"modified_dateutc": "2026-10-09T07:42:06.5973413+00:00"
},
"date_in_production_since": "2026-10-09T07:42:06.5973413+00:00",
"date_out_of_production_since": "2026-10-09T07:42:06.5973413+00:00",
"date_end_support": "2026-10-09T07:42:06.5973413+00:00",
"sales_organization_id": "6061af7d-af25-4f3d-a1fd-2b83d0dee849",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2290678a-eea6-4950-b021-875616328bc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77193032-e951-489e-b1de-19f2a24249d7",
"db_currency_id": "18a8c7eb-42b8-4a3a-a682-93a4fd135479",
"db_language_id": "6e9de665-495a-4cf5-8493-2ff39dd83146",
"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-10-09T07:42:06.5772918+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-10-09T07:42:06.5973413+00:00"
},
"project_status_id": "cefcaf78-3dc6-40c5-921f-45879c74c17e",
"project_status_code": "sample string 10",
"project_status": {
"id": "1f9424b1-f9ae-406a-bb2a-6e55db66e4c0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8e97a3c3-028a-4bc7-a0a9-e832bf4b11c4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2290678a-eea6-4950-b021-875616328bc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77193032-e951-489e-b1de-19f2a24249d7",
"db_currency_id": "18a8c7eb-42b8-4a3a-a682-93a4fd135479",
"db_language_id": "6e9de665-495a-4cf5-8493-2ff39dd83146",
"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-10-09T07:42:06.5772918+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-09T07:42:06.5973413+00:00"
},
"company_id": "050e8471-9a68-4a00-bd7e-53f9475a2c1d",
"company_code": "sample string 12",
"db_address_id": "0a85d8c6-1f45-481b-b1f8-f7813daa943d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6ecb0427-ba9b-4c83-8d4a-31744dadc2b7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "de50f0cb-5363-4409-a03d-20a1c75eb3e2",
"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-10-09T07:42:06.5973413+00:00",
"date_create": "2026-10-09T07:42:06.5973413+00:00",
"date_update": "2026-10-09T07:42:06.5973413+00:00",
"updated_by_user_id": "67484f9b-d081-4399-adbe-ae9b19d51fc7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-09T07:42:06.5973413+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-10-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-09T07:42:06.5973413+00:00",
"date_last_job": "2026-10-09T07:42:06.5973413+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-09T07:42:06.5973413+00:00",
"modified_dateutc": "2026-10-09T07:42:06.5973413+00:00",
"is_mobile_installation": true
},
"job_type_id": "7c8d0f68-3373-4043-8d71-aa1f815c3e55",
"job_type_code": "sample string 7",
"job_type": {
"id": "8d5ec2b2-cd05-4cc0-bc38-51306078cc5c",
"name": "sample string 2",
"sales_organization_id": "323226dc-9f9f-4d91-b92c-0e3d2b6b0c32",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-09T07:42:06.5973413+00:00",
"code": "sample string 7"
},
"job_priority_id": "f82de098-2db0-4a62-a4a9-07a92bcfc28e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2f976e1b-cf2d-49b4-b016-c1b0c1e4c57a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "279a9cef-faa9-4ba4-862b-a75723491d90",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2290678a-eea6-4950-b021-875616328bc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77193032-e951-489e-b1de-19f2a24249d7",
"db_currency_id": "18a8c7eb-42b8-4a3a-a682-93a4fd135479",
"db_language_id": "6e9de665-495a-4cf5-8493-2ff39dd83146",
"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-10-09T07:42:06.5772918+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-09T07:42:06.5973413+00:00"
},
"job_status_id": "dcd06824-8b2e-4192-b337-b9f06ed5e4eb",
"job_status_code": "sample string 11",
"db_address_id": "9ce0ae84-f42c-4222-bd1d-a7d6ec882e30",
"contact_id": "02d8953f-cfcf-4df1-8aa6-5d62bf3213d9",
"requested_by_company_id": "a07fd12e-8942-404a-9c7b-4db08f510a20",
"requested_by_contact_id": "36849aec-0bc9-4588-950b-d772b5458994",
"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-10-09T07:42:06.5973413+00:00",
"due_date": "2026-10-09T07:42:06.5973413+00:00",
"date_create": "2026-10-09T07:42:06.6073286+00:00",
"date_update": "2026-10-09T07:42:06.6073286+00:00",
"date_closed": "2026-10-09T07:42:06.6073286+00:00",
"suggested_user_id": "3f6d22ec-1b43-438d-9eef-0657da3f226b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "196109f4-7ab8-4dba-ae3f-138ed36e087f",
"db_language_id": "8bb747cd-b400-44ac-870f-68b22af87b67",
"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-10-09T07:42:06.6073286+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2df5b4af-4b3f-46d5-9a43-96a2244050db",
"sales_organization": {
"id": "2290678a-eea6-4950-b021-875616328bc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77193032-e951-489e-b1de-19f2a24249d7",
"db_currency_id": "18a8c7eb-42b8-4a3a-a682-93a4fd135479",
"db_language_id": "6e9de665-495a-4cf5-8493-2ff39dd83146",
"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-10-09T07:42:06.5772918+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4ef0cfc1-1f8a-4e3a-882d-d793876777e1",
"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": "e3156bb1-b052-4779-a875-5c43db566d79",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-09T07:42:06.6073286+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7698b189-15eb-43b2-a44c-a631ba7620d3"
},
"suggested_date_start": "2026-10-09T07:42:06.6073286+00:00",
"skill_id": "46bd13a6-8a9d-4c1c-97e2-f6bb0303567b",
"skill_code": "sample string 32",
"skill": {
"id": "15e1cae2-67a1-46ce-872b-cfe7faf7d990",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2e787c23-6384-46fc-a36b-22bdfa14e8cd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2290678a-eea6-4950-b021-875616328bc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77193032-e951-489e-b1de-19f2a24249d7",
"db_currency_id": "18a8c7eb-42b8-4a3a-a682-93a4fd135479",
"db_language_id": "6e9de665-495a-4cf5-8493-2ff39dd83146",
"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-10-09T07:42:06.5772918+00:00"
},
"modified_dateutc": "2026-10-09T07:42:06.6073286+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b660dd3a-3934-492e-8435-d361a3db8fd0",
"date_reported_by_company": "2026-10-09T07:42:06.6073286+00:00",
"id2": 36,
"company_id": "28b65c20-c292-4b6e-a657-da80a2312084",
"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": "4de381df-79d9-491d-8d86-188c8bc0b4dc",
"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-10-09T07:42:06.6073286+00:00"
},
"work_instruction_details_id": "a1c9acc3-920e-43d6-a5e9-e5d971ed9d8f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ddbf178f-3842-4d3c-9e81-ee19c39e3302",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "540d20b9-a637-400b-9adc-bbcfb3be80e9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-09T07:42:06.6073286+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": "ef2a3b5b-fd07-4ebe-b0f1-6d72b68a49b5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-09T07:42:06.6073286+00:00"
}