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": "a6746d72-9954-4f11-8d54-d4195d3ec080",
"jobs_id": "5b9ad62a-d869-4704-a413-a110184f33b7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8d1a5722-11b1-4d08-a935-4bba8af5baf7",
"_parent_id": "414a5f16-2220-4be4-9857-1dcbae3706b1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "433bd73b-6662-4132-8d9d-7a7432b24f00",
"project_reference_back_office": "sample string 5",
"project": {
"id": "008e5be3-3d53-4cca-ab97-df19412842cf",
"_parent_id": "9d28fc2f-c92a-496a-a110-f2edc286a88e",
"root_parent_id": "228edaa3-f418-4ab9-a9f4-5ffe042bc81d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5e7a4803-a7a5-4131-ae77-b9f252eac8a8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4115731a-72a9-47f5-afde-6e5a6409a5e2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a693dcf3-2af8-4169-bd06-0e6dafebeca6",
"_parent_code": "sample string 6",
"sales_organization_id": "0d1d8747-9e54-40d4-aeee-cde09367a69a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "39664b18-df7f-4540-9125-98952b7d500b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e5da80-3478-4dfd-b3ca-81a046b32ee0",
"db_currency_id": "a2e844a9-1c25-4dc0-bc12-051279531098",
"db_language_id": "f55e0c29-6b52-4126-8f55-d2eeb85a4960",
"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-05-01T01:19:46.8679228+00:00"
},
"modified_dateutc": "2026-05-01T01:19:46.8679228+00:00"
},
"equipment_model_id": "f7815588-694a-4c92-94e4-a4ba0ff5f0f8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "10c2cc67-6daf-4672-8756-8d9c544b2036",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "26ad3df3-ca46-4bed-8fd9-cd2871e47d28",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f5115c70-4ce7-4c08-9c36-cd4c3e4359c2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0c9501ed-03b0-4529-8620-0de523b81ee2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "39664b18-df7f-4540-9125-98952b7d500b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e5da80-3478-4dfd-b3ca-81a046b32ee0",
"db_currency_id": "a2e844a9-1c25-4dc0-bc12-051279531098",
"db_language_id": "f55e0c29-6b52-4126-8f55-d2eeb85a4960",
"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-05-01T01:19:46.8679228+00:00"
},
"modified_dateutc": "2026-05-01T01:19:46.8679228+00:00"
},
"equipment_family_id": "2a2ca1ff-f02f-41e4-bb8e-b787735d8d1f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4115731a-72a9-47f5-afde-6e5a6409a5e2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a693dcf3-2af8-4169-bd06-0e6dafebeca6",
"_parent_code": "sample string 6",
"sales_organization_id": "0d1d8747-9e54-40d4-aeee-cde09367a69a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "39664b18-df7f-4540-9125-98952b7d500b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e5da80-3478-4dfd-b3ca-81a046b32ee0",
"db_currency_id": "a2e844a9-1c25-4dc0-bc12-051279531098",
"db_language_id": "f55e0c29-6b52-4126-8f55-d2eeb85a4960",
"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-05-01T01:19:46.8679228+00:00"
},
"modified_dateutc": "2026-05-01T01:19:46.8679228+00:00"
},
"date_in_production_since": "2026-05-01T01:19:46.8679228+00:00",
"date_out_of_production_since": "2026-05-01T01:19:46.8679228+00:00",
"date_end_support": "2026-05-01T01:19:46.8679228+00:00",
"sales_organization_id": "34453684-2955-4378-bae8-73e2eafbe71f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "39664b18-df7f-4540-9125-98952b7d500b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e5da80-3478-4dfd-b3ca-81a046b32ee0",
"db_currency_id": "a2e844a9-1c25-4dc0-bc12-051279531098",
"db_language_id": "f55e0c29-6b52-4126-8f55-d2eeb85a4960",
"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-05-01T01:19:46.8679228+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-05-01T01:19:46.8679228+00:00"
},
"project_status_id": "13a207af-ac18-4368-b8dc-f22fcb02a202",
"project_status_code": "sample string 10",
"project_status": {
"id": "04eeb7d3-7c1f-4d32-9585-42470ea9c0db",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a48b22f3-f06e-4ed8-80aa-5dc121746b6b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "39664b18-df7f-4540-9125-98952b7d500b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e5da80-3478-4dfd-b3ca-81a046b32ee0",
"db_currency_id": "a2e844a9-1c25-4dc0-bc12-051279531098",
"db_language_id": "f55e0c29-6b52-4126-8f55-d2eeb85a4960",
"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-05-01T01:19:46.8679228+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-01T01:19:46.8679228+00:00"
},
"company_id": "b3742561-2561-4210-8a03-44eabafab3db",
"company_code": "sample string 12",
"db_address_id": "034cb0b7-b8a8-45ff-af06-9e0321a5d16b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6c0452f2-ad4f-401f-9569-e653c4f77042",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "78f84058-e815-4db4-becd-7bdb42cf5508",
"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-05-01T01:19:46.8679228+00:00",
"date_create": "2026-05-01T01:19:46.8679228+00:00",
"date_update": "2026-05-01T01:19:46.8679228+00:00",
"updated_by_user_id": "1fde5a1c-eed9-449f-af31-9e8dddc309ba",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-01T01:19:46.8679228+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-05-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-01T01:19:46.8679228+00:00",
"date_last_job": "2026-05-01T01:19:46.8679228+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-01T01:19:46.8679228+00:00",
"modified_dateutc": "2026-05-01T01:19:46.8679228+00:00",
"is_mobile_installation": true
},
"job_type_id": "e17d899d-7709-4293-80dc-f15370ed5349",
"job_type_code": "sample string 7",
"job_type": {
"id": "7d5dcf8a-deb6-4ef5-8ff2-bdccd893db45",
"name": "sample string 2",
"sales_organization_id": "20d0b943-f0bb-42ee-af1b-0f6aa7a3fedd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-01T01:19:46.8679228+00:00",
"code": "sample string 7"
},
"job_priority_id": "6cb198e5-1fc9-435d-beea-98df84d9e21e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "37cde1d2-3de3-4572-bc0d-539a0e304f4a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "dcf6f2f7-7548-4bf3-91e1-d4a40f123614",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "39664b18-df7f-4540-9125-98952b7d500b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e5da80-3478-4dfd-b3ca-81a046b32ee0",
"db_currency_id": "a2e844a9-1c25-4dc0-bc12-051279531098",
"db_language_id": "f55e0c29-6b52-4126-8f55-d2eeb85a4960",
"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-05-01T01:19:46.8679228+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-01T01:19:46.8679228+00:00"
},
"job_status_id": "7ed24bd3-2501-4335-bdc7-f0a3a6008814",
"job_status_code": "sample string 11",
"db_address_id": "a3be1844-f144-4575-9fc5-4ca56884ffc6",
"contact_id": "fae971f6-b208-4179-8c53-b9a06a512401",
"requested_by_company_id": "a70739f6-81a2-4ee4-b8bd-61c3f794524f",
"requested_by_contact_id": "b5e058c7-33ef-43de-a2fe-5ce3ddc14fd2",
"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-05-01T01:19:46.8679228+00:00",
"due_date": "2026-05-01T01:19:46.8679228+00:00",
"date_create": "2026-05-01T01:19:46.8679228+00:00",
"date_update": "2026-05-01T01:19:46.8679228+00:00",
"date_closed": "2026-05-01T01:19:46.8679228+00:00",
"suggested_user_id": "081d2775-353b-428e-bb93-5729614ef7ce",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bdfd38e1-9f08-45a6-9f65-ab280547104a",
"db_language_id": "8f9fc6e4-8b29-4e1c-bfe0-5c8ddfa06e76",
"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-05-01T01:19:46.8679228+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "259a4360-a043-4532-b3b5-7528e6ae842c",
"sales_organization": {
"id": "39664b18-df7f-4540-9125-98952b7d500b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e5da80-3478-4dfd-b3ca-81a046b32ee0",
"db_currency_id": "a2e844a9-1c25-4dc0-bc12-051279531098",
"db_language_id": "f55e0c29-6b52-4126-8f55-d2eeb85a4960",
"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-05-01T01:19:46.8679228+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "613f4834-f064-44c4-afbf-714eb11c19a3",
"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": "70a00a79-f212-400f-92e5-03ff0aa0b141",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-01T01:19:46.8679228+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6bd370f3-6740-47df-91de-b3053570f58f"
},
"suggested_date_start": "2026-05-01T01:19:46.8679228+00:00",
"skill_id": "dbe9bce5-e3d1-49ec-8e96-4fca7dc3d0fc",
"skill_code": "sample string 32",
"skill": {
"id": "7c9b333d-7254-4a9b-8439-59262c1d9926",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "78a1342d-4d44-41ad-8b5b-437f5789e299",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "39664b18-df7f-4540-9125-98952b7d500b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e5da80-3478-4dfd-b3ca-81a046b32ee0",
"db_currency_id": "a2e844a9-1c25-4dc0-bc12-051279531098",
"db_language_id": "f55e0c29-6b52-4126-8f55-d2eeb85a4960",
"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-05-01T01:19:46.8679228+00:00"
},
"modified_dateutc": "2026-05-01T01:19:46.8679228+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "035787f4-c955-4a80-9839-0ae36803e8d0",
"date_reported_by_company": "2026-05-01T01:19:46.8679228+00:00",
"id2": 36,
"company_id": "414565f9-efa7-4c4e-b846-28341ab42451",
"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": "0c950b95-ba5c-4ddb-9b11-be6444df3e6d",
"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-05-01T01:19:46.8679228+00:00"
},
"work_instruction_details_id": "655cee4c-a045-409b-8843-b1413fcfd54d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9159ce58-9e4f-4733-a371-49f9a516cc22",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "42362894-6e0f-4c9f-a044-91ebddd08150",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-01T01:19:46.8679228+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": "3def319b-c0a8-4850-9ab1-54b75a61a7a7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-01T01:19:46.8679228+00:00"
}