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": "b5d65c42-c789-45c4-8437-f502365122b7",
"jobs_id": "613d7179-c665-425b-bac7-1fa5b7616709",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6b968163-1f28-4c23-b378-ee3ac2adc663",
"_parent_id": "4ac6a97b-0115-4c8e-90f6-e2a61901a13d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d1a19260-b0e8-42a2-8b00-d70ec3f6413c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5f5a97e9-aef4-4d83-bef0-f13d1ea0f855",
"_parent_id": "7e5c08c1-d67a-4066-a875-609b9c452616",
"root_parent_id": "510afc78-dc25-4002-b6cf-6d2d6d1383cb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c483f302-256f-4643-b779-13358332028e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "921ef6eb-a2e4-453b-afe9-b2d15c27dbf9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9bc3c5b7-f2f2-4f88-b35d-b2855eec5540",
"_parent_code": "sample string 6",
"sales_organization_id": "797cd87d-77a5-4c0f-a67f-9a38b6217940",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c335fb74-7ea3-433c-bcdc-2f51654fda2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bba20-a3db-4cd1-a32a-5fcf5b59dc5e",
"db_currency_id": "4b01cbdb-3b80-40a5-ba04-8fd1c3575e1a",
"db_language_id": "8ea2f1b7-f828-4359-9eaa-21cf9c8292a4",
"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-04-04T06:15:35.3881501+00:00"
},
"modified_dateutc": "2026-04-04T06:15:35.3881501+00:00"
},
"equipment_model_id": "545632a5-1b7c-4cd4-80c6-e029a2c10e81",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0114fa72-cd36-4f82-a270-2c96371f964f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1d4491f4-07e3-418d-858f-bf6bc4f9b7db",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b9cd8cbe-8764-4814-9385-0247bbd85458",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3f64e4d1-f9f6-4ab8-b35d-5e007a1a241c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c335fb74-7ea3-433c-bcdc-2f51654fda2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bba20-a3db-4cd1-a32a-5fcf5b59dc5e",
"db_currency_id": "4b01cbdb-3b80-40a5-ba04-8fd1c3575e1a",
"db_language_id": "8ea2f1b7-f828-4359-9eaa-21cf9c8292a4",
"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-04-04T06:15:35.3881501+00:00"
},
"modified_dateutc": "2026-04-04T06:15:35.3881501+00:00"
},
"equipment_family_id": "ac05b53b-d3b7-4d90-abc9-b4acc69557ec",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "921ef6eb-a2e4-453b-afe9-b2d15c27dbf9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9bc3c5b7-f2f2-4f88-b35d-b2855eec5540",
"_parent_code": "sample string 6",
"sales_organization_id": "797cd87d-77a5-4c0f-a67f-9a38b6217940",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c335fb74-7ea3-433c-bcdc-2f51654fda2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bba20-a3db-4cd1-a32a-5fcf5b59dc5e",
"db_currency_id": "4b01cbdb-3b80-40a5-ba04-8fd1c3575e1a",
"db_language_id": "8ea2f1b7-f828-4359-9eaa-21cf9c8292a4",
"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-04-04T06:15:35.3881501+00:00"
},
"modified_dateutc": "2026-04-04T06:15:35.3881501+00:00"
},
"date_in_production_since": "2026-04-04T06:15:35.3881501+00:00",
"date_out_of_production_since": "2026-04-04T06:15:35.3881501+00:00",
"date_end_support": "2026-04-04T06:15:35.3881501+00:00",
"sales_organization_id": "b5059f82-4990-486f-ba92-473f22079d50",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c335fb74-7ea3-433c-bcdc-2f51654fda2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bba20-a3db-4cd1-a32a-5fcf5b59dc5e",
"db_currency_id": "4b01cbdb-3b80-40a5-ba04-8fd1c3575e1a",
"db_language_id": "8ea2f1b7-f828-4359-9eaa-21cf9c8292a4",
"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-04-04T06:15:35.3881501+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-04-04T06:15:35.3881501+00:00"
},
"project_status_id": "97b5c1af-6386-4da6-9c7c-43cd8ca00ebd",
"project_status_code": "sample string 10",
"project_status": {
"id": "b8233b1c-400e-49f3-8b49-d90b048ef947",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0ea0345d-e9c1-48e0-a3ff-7311822fda39",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c335fb74-7ea3-433c-bcdc-2f51654fda2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bba20-a3db-4cd1-a32a-5fcf5b59dc5e",
"db_currency_id": "4b01cbdb-3b80-40a5-ba04-8fd1c3575e1a",
"db_language_id": "8ea2f1b7-f828-4359-9eaa-21cf9c8292a4",
"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-04-04T06:15:35.3881501+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-04T06:15:35.3881501+00:00"
},
"company_id": "6c144a8f-004f-4022-a3d5-b5b0daa9aea1",
"company_code": "sample string 12",
"db_address_id": "08e09ec1-f19b-4837-abef-ea388d6306e5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "85f0279a-0733-4535-809a-1323969cb4a1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "444e6b17-ceae-4b81-af68-201336d3340d",
"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-04-04T06:15:35.3881501+00:00",
"date_create": "2026-04-04T06:15:35.3881501+00:00",
"date_update": "2026-04-04T06:15:35.3881501+00:00",
"updated_by_user_id": "b8fb29e0-9206-452f-a833-61c684d498bb",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-04T06:15:35.3881501+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-04-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-04T06:15:35.3881501+00:00",
"date_last_job": "2026-04-04T06:15:35.3881501+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-04T06:15:35.3881501+00:00",
"modified_dateutc": "2026-04-04T06:15:35.3881501+00:00",
"is_mobile_installation": true
},
"job_type_id": "a9e52636-def4-4607-8567-15a6002250d4",
"job_type_code": "sample string 7",
"job_type": {
"id": "32402fd3-8e1f-4d62-8b61-ff99ab136699",
"name": "sample string 2",
"sales_organization_id": "16b1fe80-488f-479f-bb98-311ed985915f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-04T06:15:35.3881501+00:00",
"code": "sample string 7"
},
"job_priority_id": "cce2efe7-248a-4b29-b395-d75092b88110",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b4705567-ac1b-4d77-9525-0ce525e6534a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "aa5c2610-bc68-4533-9b2f-7ef1f1cfacff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c335fb74-7ea3-433c-bcdc-2f51654fda2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bba20-a3db-4cd1-a32a-5fcf5b59dc5e",
"db_currency_id": "4b01cbdb-3b80-40a5-ba04-8fd1c3575e1a",
"db_language_id": "8ea2f1b7-f828-4359-9eaa-21cf9c8292a4",
"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-04-04T06:15:35.3881501+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-04T06:15:35.3881501+00:00"
},
"job_status_id": "7a142598-fb24-4062-92f8-6d069239397c",
"job_status_code": "sample string 11",
"db_address_id": "6ab92bf1-f73b-4230-844d-f923d68ba8ba",
"contact_id": "28217d1a-4793-41a6-b1a0-8d3f869cb2e9",
"requested_by_company_id": "0048a60e-4a30-496b-80ac-13dd8b9088aa",
"requested_by_contact_id": "ca566771-2468-4286-bff0-d1a1018092d8",
"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-04-04T06:15:35.3881501+00:00",
"due_date": "2026-04-04T06:15:35.3881501+00:00",
"date_create": "2026-04-04T06:15:35.3881501+00:00",
"date_update": "2026-04-04T06:15:35.3881501+00:00",
"date_closed": "2026-04-04T06:15:35.3881501+00:00",
"suggested_user_id": "eb7917e3-39c7-4cef-9421-cf332c053578",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "55716e66-772e-499e-8e87-e85e1643604e",
"db_language_id": "91295bf4-5960-4845-99da-51eba9cc63c8",
"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-04-04T06:15:35.3881501+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9a74a64d-9d54-4990-b9e1-9722390f4a23",
"sales_organization": {
"id": "c335fb74-7ea3-433c-bcdc-2f51654fda2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bba20-a3db-4cd1-a32a-5fcf5b59dc5e",
"db_currency_id": "4b01cbdb-3b80-40a5-ba04-8fd1c3575e1a",
"db_language_id": "8ea2f1b7-f828-4359-9eaa-21cf9c8292a4",
"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-04-04T06:15:35.3881501+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a73b0914-9a11-45d9-aa84-baee79de76ce",
"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": "7b53e014-4f03-41f0-b32a-c24e7f0811b3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-04T06:15:35.4037758+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8353c25e-9c10-4b7b-b51b-244b3a1e7114"
},
"suggested_date_start": "2026-04-04T06:15:35.4037758+00:00",
"skill_id": "67c87ccb-7336-4f8c-b967-7971363d7745",
"skill_code": "sample string 32",
"skill": {
"id": "c3d4232e-690c-47d7-9863-81c4b3ce6391",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fa170ec0-62e8-49e6-95b5-d2ed90c37143",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c335fb74-7ea3-433c-bcdc-2f51654fda2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bba20-a3db-4cd1-a32a-5fcf5b59dc5e",
"db_currency_id": "4b01cbdb-3b80-40a5-ba04-8fd1c3575e1a",
"db_language_id": "8ea2f1b7-f828-4359-9eaa-21cf9c8292a4",
"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-04-04T06:15:35.3881501+00:00"
},
"modified_dateutc": "2026-04-04T06:15:35.4037758+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0d4e9a0a-b7bb-42e7-b4fa-c5aac72e87a8",
"date_reported_by_company": "2026-04-04T06:15:35.4037758+00:00",
"id2": 36,
"company_id": "82cb90fa-f8f2-4b3d-b8ce-baa808a78418",
"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": "58cf072c-b450-4ad6-afc3-e60f47dd766f",
"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-04-04T06:15:35.4037758+00:00"
},
"work_instruction_details_id": "b9d6e01f-b71f-42e9-be87-9a1138cea48b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4f4b70ad-75eb-4587-8f83-fd0cf2deca31",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "89dd9989-40ee-42dd-8a67-3de8eb8a5822",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-04T06:15:35.4037758+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": "78813839-e6e1-41fe-830b-019a2fa361a0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-04T06:15:35.4037758+00:00"
}