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": "aa16ecd4-a882-48ec-9b47-6bf8ed896eeb",
"jobs_id": "7c8dc948-04fa-47ac-bf72-42c5ed0aea52",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d9b20a29-6ba7-4886-8904-527efe1b5077",
"_parent_id": "2c4a5870-6851-48f3-88be-f8b73ef04683",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0793d9a7-8b53-4890-b734-cd017f0a8c6f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cd696c1a-e846-4664-b130-4ffc109a53d7",
"_parent_id": "f54b96c1-d6d9-47b8-baea-c729cc3ad0e5",
"root_parent_id": "c3fa64f0-b132-4eea-9962-c931b33f6158",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fe6ee6a9-872d-46f8-9d42-90f93bdb5a69",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "75c72e93-626a-4d19-8d6b-3db28a6612a1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "089b2e9e-c74f-4cff-98d8-beee9b1ca932",
"_parent_code": "sample string 6",
"sales_organization_id": "3c79da76-c551-41c2-9051-f0de3838e4d8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "15cb4f55-d62c-4ea4-ba3e-bbd6b40074c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c89e8b6-7519-4e92-90ca-177197a0bcea",
"db_currency_id": "617e5644-8fe9-4da2-8d38-f3f274e9d81d",
"db_language_id": "517fd8da-c968-4d99-87f0-ab0d13d77539",
"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-09-19T22:00:27.0279436+00:00"
},
"modified_dateutc": "2026-09-19T22:00:27.0279436+00:00"
},
"equipment_model_id": "5870d351-8014-442a-b305-0a0ef1622f71",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "83367d63-50ff-4911-b53e-8dbc7cd702c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b8c23e4f-d433-4da6-ab65-90e763af1508",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "77bce884-0b0b-4c24-bf86-e98f177a5464",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4a10e0f0-a946-469d-a6e7-7d24a1ab175f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "15cb4f55-d62c-4ea4-ba3e-bbd6b40074c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c89e8b6-7519-4e92-90ca-177197a0bcea",
"db_currency_id": "617e5644-8fe9-4da2-8d38-f3f274e9d81d",
"db_language_id": "517fd8da-c968-4d99-87f0-ab0d13d77539",
"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-09-19T22:00:27.0279436+00:00"
},
"modified_dateutc": "2026-09-19T22:00:27.0279436+00:00"
},
"equipment_family_id": "0656dfca-3b86-4db1-bc8f-c67954e30e31",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "75c72e93-626a-4d19-8d6b-3db28a6612a1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "089b2e9e-c74f-4cff-98d8-beee9b1ca932",
"_parent_code": "sample string 6",
"sales_organization_id": "3c79da76-c551-41c2-9051-f0de3838e4d8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "15cb4f55-d62c-4ea4-ba3e-bbd6b40074c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c89e8b6-7519-4e92-90ca-177197a0bcea",
"db_currency_id": "617e5644-8fe9-4da2-8d38-f3f274e9d81d",
"db_language_id": "517fd8da-c968-4d99-87f0-ab0d13d77539",
"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-09-19T22:00:27.0279436+00:00"
},
"modified_dateutc": "2026-09-19T22:00:27.0279436+00:00"
},
"date_in_production_since": "2026-09-19T22:00:27.0279436+00:00",
"date_out_of_production_since": "2026-09-19T22:00:27.0279436+00:00",
"date_end_support": "2026-09-19T22:00:27.0279436+00:00",
"sales_organization_id": "708baef9-f3ca-4494-a926-cb9aed507b53",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "15cb4f55-d62c-4ea4-ba3e-bbd6b40074c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c89e8b6-7519-4e92-90ca-177197a0bcea",
"db_currency_id": "617e5644-8fe9-4da2-8d38-f3f274e9d81d",
"db_language_id": "517fd8da-c968-4d99-87f0-ab0d13d77539",
"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-09-19T22:00:27.0279436+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-09-19T22:00:27.0279436+00:00"
},
"project_status_id": "84044a68-aa2b-4bb9-b100-7e0516dd6c20",
"project_status_code": "sample string 10",
"project_status": {
"id": "95a29a3e-c42b-4baa-88b6-a5c0305fb19d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "78a6f2e1-5b77-440b-b93e-9a7379f885b0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "15cb4f55-d62c-4ea4-ba3e-bbd6b40074c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c89e8b6-7519-4e92-90ca-177197a0bcea",
"db_currency_id": "617e5644-8fe9-4da2-8d38-f3f274e9d81d",
"db_language_id": "517fd8da-c968-4d99-87f0-ab0d13d77539",
"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-09-19T22:00:27.0279436+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-19T22:00:27.0279436+00:00"
},
"company_id": "57a93ef4-e7c3-461d-8703-aa8fd201d649",
"company_code": "sample string 12",
"db_address_id": "19940255-90c6-4f83-9b8a-9cf3dae86d5b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "aa1bbdb4-8a9b-42ac-a800-f9ea2c108523",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c54f60f3-0a71-4971-b596-d07afbe968c1",
"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-09-19T22:00:27.0279436+00:00",
"date_create": "2026-09-19T22:00:27.0279436+00:00",
"date_update": "2026-09-19T22:00:27.0279436+00:00",
"updated_by_user_id": "358c0a97-7923-4c01-b188-039418611006",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-19T22:00:27.0279436+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-09-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-19T22:00:27.0279436+00:00",
"date_last_job": "2026-09-19T22:00:27.0279436+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-19T22:00:27.0279436+00:00",
"modified_dateutc": "2026-09-19T22:00:27.0279436+00:00",
"is_mobile_installation": true
},
"job_type_id": "3587d737-1b94-461a-abea-adf2fe44e8ff",
"job_type_code": "sample string 7",
"job_type": {
"id": "96677553-0048-4923-8fb9-67254214a578",
"name": "sample string 2",
"sales_organization_id": "346f8384-e699-407c-8542-d9a5a5e22bc4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-19T22:00:27.0279436+00:00",
"code": "sample string 7"
},
"job_priority_id": "447521f3-199a-48fe-bfa3-be82973a3140",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "dc307114-a6b3-4ec3-a8bb-af864246d234",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "13d0333e-bdf3-440f-832d-43e00c392965",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "15cb4f55-d62c-4ea4-ba3e-bbd6b40074c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c89e8b6-7519-4e92-90ca-177197a0bcea",
"db_currency_id": "617e5644-8fe9-4da2-8d38-f3f274e9d81d",
"db_language_id": "517fd8da-c968-4d99-87f0-ab0d13d77539",
"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-09-19T22:00:27.0279436+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-19T22:00:27.0279436+00:00"
},
"job_status_id": "3f2eb66f-bb08-45e2-931f-d0dd37bd07c4",
"job_status_code": "sample string 11",
"db_address_id": "7db497bd-9caa-4b86-be39-29596b886bc1",
"contact_id": "2f60e8bc-2130-41af-a188-941efebe656f",
"requested_by_company_id": "cf33a6d9-7a2c-4d89-9aa5-ea6fa2a43fd8",
"requested_by_contact_id": "c146a27b-d49f-469c-83d1-3ed197c08906",
"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-09-19T22:00:27.0279436+00:00",
"due_date": "2026-09-19T22:00:27.0279436+00:00",
"date_create": "2026-09-19T22:00:27.0279436+00:00",
"date_update": "2026-09-19T22:00:27.0279436+00:00",
"date_closed": "2026-09-19T22:00:27.0279436+00:00",
"suggested_user_id": "a64a6082-39b7-4098-91fd-12839ffb7c28",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b18ffcc0-f0e1-4330-8a9b-8e8553dc0441",
"db_language_id": "bc6630c3-6d25-45af-b74e-16adc41bf779",
"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-09-19T22:00:27.0279436+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7832bf20-f867-43a3-9018-c06a17ecbd9e",
"sales_organization": {
"id": "15cb4f55-d62c-4ea4-ba3e-bbd6b40074c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c89e8b6-7519-4e92-90ca-177197a0bcea",
"db_currency_id": "617e5644-8fe9-4da2-8d38-f3f274e9d81d",
"db_language_id": "517fd8da-c968-4d99-87f0-ab0d13d77539",
"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-09-19T22:00:27.0279436+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6a260c9d-8b0e-4317-bafe-2993434086a1",
"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": "13ba9dae-6776-489b-afb1-e6ee906de068",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-19T22:00:27.0279436+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b5e01a8d-e24f-4bc6-b155-bc81d895c750"
},
"suggested_date_start": "2026-09-19T22:00:27.0279436+00:00",
"skill_id": "28152405-0bc4-4d78-b2f7-20060d3f6747",
"skill_code": "sample string 32",
"skill": {
"id": "93d931f6-eaeb-48c0-a5d0-353ba2715aa6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6d2b75d4-91c7-4054-9173-b80c9e99cd51",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "15cb4f55-d62c-4ea4-ba3e-bbd6b40074c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c89e8b6-7519-4e92-90ca-177197a0bcea",
"db_currency_id": "617e5644-8fe9-4da2-8d38-f3f274e9d81d",
"db_language_id": "517fd8da-c968-4d99-87f0-ab0d13d77539",
"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-09-19T22:00:27.0279436+00:00"
},
"modified_dateutc": "2026-09-19T22:00:27.0279436+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e361903d-e24e-402b-a590-8e8337e6676e",
"date_reported_by_company": "2026-09-19T22:00:27.0279436+00:00",
"id2": 36,
"company_id": "d0ca9b24-987d-4fa4-8db4-cbb0ba64d9a7",
"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": "99de7285-e986-41d0-a159-866e9edbd8dd",
"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-09-19T22:00:27.0279436+00:00"
},
"work_instruction_details_id": "228856e4-0436-46d9-b0a1-47c6242bffd6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4da7b4a2-4c06-4949-93f7-9ba200f378b6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "81c478f2-0705-4686-bbf3-5cd370cc47c0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-19T22:00:27.0279436+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": "6cc687dd-a32c-4c62-9204-b663f767ab44",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-19T22:00:27.0279436+00:00"
}