Retrieves the job work instruction list with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
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": "629ed36b-ebdb-46e6-ba88-6e75d44acadf",
"jobs_id": "48c1fa1e-fa43-4a41-8100-491c3c86bb89",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2f2adf8b-7f84-49ae-afa7-2992ec4281f1",
"_parent_id": "7131c4bb-eb57-4e75-a340-257f7ee275d7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "acba5259-d0a5-4359-af2d-91edbe8a7f3b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3e894d0b-4b0d-4514-8801-85aa114f7e98",
"_parent_id": "5a79477f-c542-4f16-935c-2a7034f11e62",
"root_parent_id": "115553b5-681f-4b14-b42b-e1e88aa4507b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "defdd5f6-3520-4120-8f38-2125356d2b33",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "10e19a06-25fc-40cd-96b8-52fa9ac6bcc8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a4608ea7-37bf-4c92-96fd-427668f47b3f",
"_parent_code": "sample string 6",
"sales_organization_id": "f76d3da2-2559-4790-aa58-94211ac2ec19",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9ebfb21d-2f01-4681-9a3d-e1c1a5332103",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be9ffe33-faaf-43f8-a1b3-a24dc0bbb07f",
"db_currency_id": "a67cdef8-a319-438a-b448-fd53f606dee4",
"db_language_id": "2ce8f644-8ad2-4f70-a388-003bf56d0664",
"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-14T05:28:19.6089872+00:00"
},
"modified_dateutc": "2026-04-14T05:28:19.6089872+00:00"
},
"equipment_model_id": "1f688467-0be0-4f13-9183-df038657507b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "45708ef7-464d-47cf-be21-b8cf2b9e8e36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "da6ffb27-055f-4158-9905-280604de486d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "76676ef2-b929-4872-96cf-b52b5b547ed4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "09c46bc5-580a-45b8-88d6-827ae92afed4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9ebfb21d-2f01-4681-9a3d-e1c1a5332103",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be9ffe33-faaf-43f8-a1b3-a24dc0bbb07f",
"db_currency_id": "a67cdef8-a319-438a-b448-fd53f606dee4",
"db_language_id": "2ce8f644-8ad2-4f70-a388-003bf56d0664",
"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-14T05:28:19.6089872+00:00"
},
"modified_dateutc": "2026-04-14T05:28:19.6089872+00:00"
},
"equipment_family_id": "62feaa1d-f766-46a4-bff5-bce14d5f6efb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "10e19a06-25fc-40cd-96b8-52fa9ac6bcc8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a4608ea7-37bf-4c92-96fd-427668f47b3f",
"_parent_code": "sample string 6",
"sales_organization_id": "f76d3da2-2559-4790-aa58-94211ac2ec19",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9ebfb21d-2f01-4681-9a3d-e1c1a5332103",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be9ffe33-faaf-43f8-a1b3-a24dc0bbb07f",
"db_currency_id": "a67cdef8-a319-438a-b448-fd53f606dee4",
"db_language_id": "2ce8f644-8ad2-4f70-a388-003bf56d0664",
"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-14T05:28:19.6089872+00:00"
},
"modified_dateutc": "2026-04-14T05:28:19.6089872+00:00"
},
"date_in_production_since": "2026-04-14T05:28:19.6089872+00:00",
"date_out_of_production_since": "2026-04-14T05:28:19.6089872+00:00",
"date_end_support": "2026-04-14T05:28:19.6089872+00:00",
"sales_organization_id": "d720f025-86f4-455d-ab47-4f9595f224ad",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9ebfb21d-2f01-4681-9a3d-e1c1a5332103",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be9ffe33-faaf-43f8-a1b3-a24dc0bbb07f",
"db_currency_id": "a67cdef8-a319-438a-b448-fd53f606dee4",
"db_language_id": "2ce8f644-8ad2-4f70-a388-003bf56d0664",
"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-14T05:28:19.6089872+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-14T05:28:19.6089872+00:00"
},
"project_status_id": "1097ffc5-56a9-452c-ab11-219fe5a49afd",
"project_status_code": "sample string 10",
"project_status": {
"id": "1972dfa6-8421-4dc6-bd37-b3ef779562e6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "87cd284c-7126-466e-8ddd-06825518b770",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ebfb21d-2f01-4681-9a3d-e1c1a5332103",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be9ffe33-faaf-43f8-a1b3-a24dc0bbb07f",
"db_currency_id": "a67cdef8-a319-438a-b448-fd53f606dee4",
"db_language_id": "2ce8f644-8ad2-4f70-a388-003bf56d0664",
"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-14T05:28:19.6089872+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-14T05:28:19.6089872+00:00"
},
"company_id": "6e628eb2-7c54-4832-8cc4-bbc5b2bf14f7",
"company_code": "sample string 12",
"db_address_id": "e587497d-b474-4d99-acc0-782a2790f876",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "068ccb62-e5cd-4ee0-b109-5e16675fd7e2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a1a388be-b4e2-4bb3-9c18-70d3c942d911",
"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-14T05:28:19.6089872+00:00",
"date_create": "2026-04-14T05:28:19.6089872+00:00",
"date_update": "2026-04-14T05:28:19.6089872+00:00",
"updated_by_user_id": "36812b95-86a9-47bf-9d01-96e92d9a6c17",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-14T05:28:19.6089872+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-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-14T05:28:19.6089872+00:00",
"date_last_job": "2026-04-14T05:28:19.6089872+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-14T05:28:19.6089872+00:00",
"modified_dateutc": "2026-04-14T05:28:19.6089872+00:00",
"is_mobile_installation": true
},
"job_type_id": "f953028d-c631-4d22-87f9-2907fcf35da3",
"job_type_code": "sample string 7",
"job_type": {
"id": "1c17e287-8258-41d0-bc5c-c9a9bd2fcc3a",
"name": "sample string 2",
"sales_organization_id": "1b68f328-ffe5-4338-acc7-25950264ba35",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-14T05:28:19.6089872+00:00",
"code": "sample string 7"
},
"job_priority_id": "59168264-5f27-47e8-8f43-8e48c9f078db",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "747927ac-66d6-479e-baec-567a76689ed2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ae746a52-dca8-4e25-ac73-49b6b912ff2d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ebfb21d-2f01-4681-9a3d-e1c1a5332103",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be9ffe33-faaf-43f8-a1b3-a24dc0bbb07f",
"db_currency_id": "a67cdef8-a319-438a-b448-fd53f606dee4",
"db_language_id": "2ce8f644-8ad2-4f70-a388-003bf56d0664",
"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-14T05:28:19.6089872+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-14T05:28:19.6246135+00:00"
},
"job_status_id": "87243b0d-fb3a-4a4e-a4f2-e55ed6bbac45",
"job_status_code": "sample string 11",
"db_address_id": "ed4e706a-e43a-430b-9081-bd26bd916485",
"contact_id": "ef319040-2e88-4533-bd53-c82263e49ddf",
"requested_by_company_id": "558eed91-5fdd-414b-898d-704e0f2bcebf",
"requested_by_contact_id": "6b9f6a1e-c022-49b8-9111-6eaa9d14b34a",
"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-14T05:28:19.6246135+00:00",
"due_date": "2026-04-14T05:28:19.6246135+00:00",
"date_create": "2026-04-14T05:28:19.6246135+00:00",
"date_update": "2026-04-14T05:28:19.6246135+00:00",
"date_closed": "2026-04-14T05:28:19.6246135+00:00",
"suggested_user_id": "677f33d4-dd1e-46f2-9cd7-a77e7cb2e860",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4ded42dc-3ff8-49c9-9068-80503d099998",
"db_language_id": "8c419fba-c2b9-4e3a-a398-fa4ea654c7e7",
"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-14T05:28:19.6246135+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "076df7ee-abca-4b7a-954d-91a8d056207a",
"sales_organization": {
"id": "9ebfb21d-2f01-4681-9a3d-e1c1a5332103",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be9ffe33-faaf-43f8-a1b3-a24dc0bbb07f",
"db_currency_id": "a67cdef8-a319-438a-b448-fd53f606dee4",
"db_language_id": "2ce8f644-8ad2-4f70-a388-003bf56d0664",
"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-14T05:28:19.6089872+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "232099a7-4455-4846-be45-651a7bd1d6c7",
"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": "15551230-0999-42b6-8f6d-e2bc205095d8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-14T05:28:19.6246135+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "93f30eb0-4b10-430b-997e-48b1ef272bfe"
},
"suggested_date_start": "2026-04-14T05:28:19.6246135+00:00",
"skill_id": "bb19be81-3df8-4f93-8933-fe3fbbc1a718",
"skill_code": "sample string 32",
"skill": {
"id": "5e71fc87-5de8-4ef6-bcb0-1280b0aaea99",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e1b91fc9-bc8d-4193-b31b-d7f8b27484a1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ebfb21d-2f01-4681-9a3d-e1c1a5332103",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be9ffe33-faaf-43f8-a1b3-a24dc0bbb07f",
"db_currency_id": "a67cdef8-a319-438a-b448-fd53f606dee4",
"db_language_id": "2ce8f644-8ad2-4f70-a388-003bf56d0664",
"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-14T05:28:19.6089872+00:00"
},
"modified_dateutc": "2026-04-14T05:28:19.6246135+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bcb40ba5-1439-45f8-8948-3635ae992cf1",
"date_reported_by_company": "2026-04-14T05:28:19.6246135+00:00",
"id2": 36,
"company_id": "9d4f5423-0245-422c-8fac-694355f5a84f",
"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": "c27840f5-c696-4de5-bde1-f730e50944f7",
"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-14T05:28:19.6246135+00:00"
},
"work_instruction_details_id": "bd4f5fc6-1160-48be-915a-9666419e20f4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "669dcc7c-ceb7-4dce-8ce4-53938123a500",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0f72411d-79d5-4165-9182-38ab98ade40e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-14T05:28:19.6246135+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": "eb88a6bc-7a79-4258-9693-7f147a210d39",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-14T05:28:19.6246135+00:00"
}