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": "28b37629-ebaf-4376-9872-d3fdb8c0cd08",
"jobs_id": "a88fabc0-92cc-4af2-a478-bfbb708bcbe6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "61746c46-6931-492c-be04-f3b122c85dfb",
"_parent_id": "28b7b543-4b84-4acd-848f-c08ce0760321",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1aae990a-29cf-47f7-a27a-b18ca3d05ed5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8b16f895-17d6-417b-80dd-1c1174051c1c",
"_parent_id": "5a0926da-c4d3-453b-be43-e6eb1bd7bc27",
"root_parent_id": "5912da74-7768-4f16-8412-ee38b3f56556",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ec97f100-eec1-401c-934a-316212172efe",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f9b9929a-7c54-4533-8133-c0753f0903cb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c00220d6-faf9-43ec-8cbc-2e32788b9263",
"_parent_code": "sample string 6",
"sales_organization_id": "cc2ad7db-875c-4bb5-8141-814a174e600d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f7832f01-bfeb-4780-b80d-cee5aa7f5a0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ccc419-ab70-48a0-9af2-7907a6b95c5e",
"db_currency_id": "51b5f317-917e-4aaf-8668-4b3281c02579",
"db_language_id": "c87e2dee-8dbd-4da3-872c-5e8687ce4287",
"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-01-14T05:18:01.1611072+00:00"
},
"modified_dateutc": "2026-01-14T05:18:01.1611072+00:00"
},
"equipment_model_id": "e9d0c48c-b065-49ea-9d78-68b8b16dc6b3",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b118fad8-a4e2-43de-a12b-27eac93ed57b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8e39e9d9-d224-48b2-81e7-18566a0b6463",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "81d637ac-9fec-4c79-9d3a-cefdd2c42053",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b02401da-ef16-43f7-920a-e866a9c5d702",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f7832f01-bfeb-4780-b80d-cee5aa7f5a0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ccc419-ab70-48a0-9af2-7907a6b95c5e",
"db_currency_id": "51b5f317-917e-4aaf-8668-4b3281c02579",
"db_language_id": "c87e2dee-8dbd-4da3-872c-5e8687ce4287",
"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-01-14T05:18:01.1611072+00:00"
},
"modified_dateutc": "2026-01-14T05:18:01.1611072+00:00"
},
"equipment_family_id": "c7180e68-de7f-4351-a2dd-2bd72d3cccc7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f9b9929a-7c54-4533-8133-c0753f0903cb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c00220d6-faf9-43ec-8cbc-2e32788b9263",
"_parent_code": "sample string 6",
"sales_organization_id": "cc2ad7db-875c-4bb5-8141-814a174e600d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f7832f01-bfeb-4780-b80d-cee5aa7f5a0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ccc419-ab70-48a0-9af2-7907a6b95c5e",
"db_currency_id": "51b5f317-917e-4aaf-8668-4b3281c02579",
"db_language_id": "c87e2dee-8dbd-4da3-872c-5e8687ce4287",
"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-01-14T05:18:01.1611072+00:00"
},
"modified_dateutc": "2026-01-14T05:18:01.1611072+00:00"
},
"date_in_production_since": "2026-01-14T05:18:01.1611072+00:00",
"date_out_of_production_since": "2026-01-14T05:18:01.1611072+00:00",
"date_end_support": "2026-01-14T05:18:01.1611072+00:00",
"sales_organization_id": "977dd7a2-e70a-48de-ac9c-4748bb2e4a49",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f7832f01-bfeb-4780-b80d-cee5aa7f5a0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ccc419-ab70-48a0-9af2-7907a6b95c5e",
"db_currency_id": "51b5f317-917e-4aaf-8668-4b3281c02579",
"db_language_id": "c87e2dee-8dbd-4da3-872c-5e8687ce4287",
"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-01-14T05:18:01.1611072+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-01-14T05:18:01.1611072+00:00"
},
"project_status_id": "95ee7d8e-3b82-4bcb-a99d-8605a9461694",
"project_status_code": "sample string 10",
"project_status": {
"id": "81363e58-4197-4ebe-987b-9e27b3011eb7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f4d7b5d4-9bf4-4a95-a265-3e607b5f8666",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f7832f01-bfeb-4780-b80d-cee5aa7f5a0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ccc419-ab70-48a0-9af2-7907a6b95c5e",
"db_currency_id": "51b5f317-917e-4aaf-8668-4b3281c02579",
"db_language_id": "c87e2dee-8dbd-4da3-872c-5e8687ce4287",
"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-01-14T05:18:01.1611072+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-14T05:18:01.1611072+00:00"
},
"company_id": "2dec08fa-80d7-49a8-8681-2aa93ec1e918",
"company_code": "sample string 12",
"db_address_id": "c9867b66-ab41-4b53-b481-d61f29414298",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "84b3f532-dddd-4c6c-9a40-8a7a855dddbd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "252dbc22-26ea-4524-ba57-bd45d41c84dd",
"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-01-14T05:18:01.1611072+00:00",
"date_create": "2026-01-14T05:18:01.1611072+00:00",
"date_update": "2026-01-14T05:18:01.1611072+00:00",
"updated_by_user_id": "7d3fc08c-c0ba-4d4d-bc4c-da62d40b51e5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-14T05:18:01.1611072+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-01-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-14T05:18:01.1611072+00:00",
"date_last_job": "2026-01-14T05:18:01.1611072+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-14T05:18:01.1611072+00:00",
"modified_dateutc": "2026-01-14T05:18:01.1611072+00:00",
"is_mobile_installation": true
},
"job_type_id": "2ab01d39-2a0e-493a-8fcd-5a2a0618ed55",
"job_type_code": "sample string 7",
"job_type": {
"id": "954d93b1-386a-4fd9-89b9-3fd76b5eaed2",
"name": "sample string 2",
"sales_organization_id": "d1604b5f-66ea-4f08-a346-102cfd685b62",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-14T05:18:01.1611072+00:00",
"code": "sample string 7"
},
"job_priority_id": "c681eefe-928f-475d-a6b7-6d5c9c285bdf",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0ee8015c-1078-4581-8ba8-5f411c1164c5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a9b70f69-886f-4293-832a-a458014b3c0a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f7832f01-bfeb-4780-b80d-cee5aa7f5a0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ccc419-ab70-48a0-9af2-7907a6b95c5e",
"db_currency_id": "51b5f317-917e-4aaf-8668-4b3281c02579",
"db_language_id": "c87e2dee-8dbd-4da3-872c-5e8687ce4287",
"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-01-14T05:18:01.1611072+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-14T05:18:01.1611072+00:00"
},
"job_status_id": "965cdc91-4a07-4259-9955-cbeac620bb45",
"job_status_code": "sample string 11",
"db_address_id": "a938cac3-7f33-4212-8254-765f68e6ff70",
"contact_id": "a0a32625-d934-418e-95be-3a5fcd0d6925",
"requested_by_company_id": "13fd6a1e-c516-4efb-88e4-dec4d7f75951",
"requested_by_contact_id": "9aab15c8-558a-41ce-a93e-85a67c5f4795",
"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-01-14T05:18:01.1611072+00:00",
"due_date": "2026-01-14T05:18:01.1611072+00:00",
"date_create": "2026-01-14T05:18:01.1611072+00:00",
"date_update": "2026-01-14T05:18:01.1611072+00:00",
"date_closed": "2026-01-14T05:18:01.1611072+00:00",
"suggested_user_id": "ff45b6cd-9e04-4930-91d9-187bcfded008",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0645952f-88c5-47ef-9fb0-29228808a63a",
"db_language_id": "cb62e6e1-8bd0-4300-b3e4-fb15b39af526",
"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-01-14T05:18:01.1611072+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3908a307-0207-4622-a078-683c15b1433c",
"sales_organization": {
"id": "f7832f01-bfeb-4780-b80d-cee5aa7f5a0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ccc419-ab70-48a0-9af2-7907a6b95c5e",
"db_currency_id": "51b5f317-917e-4aaf-8668-4b3281c02579",
"db_language_id": "c87e2dee-8dbd-4da3-872c-5e8687ce4287",
"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-01-14T05:18:01.1611072+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0b006dbc-2e93-4a52-9034-6cafe8fe65b3",
"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": "820a317f-b6a1-4141-9d41-4f1e2d8fe38b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-14T05:18:01.1611072+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "944ab630-4f19-47ac-8d6e-9a915b641485"
},
"suggested_date_start": "2026-01-14T05:18:01.1611072+00:00",
"skill_id": "3c0ba1b5-42ef-4951-9d80-4308b3eb83a6",
"skill_code": "sample string 32",
"skill": {
"id": "e0a40c68-1636-4962-bd52-a9ad5a6bcd6e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ac1eb7cf-3b7b-47e9-8cf7-5cbec7af9aae",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f7832f01-bfeb-4780-b80d-cee5aa7f5a0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ccc419-ab70-48a0-9af2-7907a6b95c5e",
"db_currency_id": "51b5f317-917e-4aaf-8668-4b3281c02579",
"db_language_id": "c87e2dee-8dbd-4da3-872c-5e8687ce4287",
"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-01-14T05:18:01.1611072+00:00"
},
"modified_dateutc": "2026-01-14T05:18:01.1611072+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "13a56711-4dbf-4636-ab03-802259d1568d",
"date_reported_by_company": "2026-01-14T05:18:01.1611072+00:00",
"id2": 36,
"company_id": "e98fd96e-f266-4c16-ac32-ff83bc617d92",
"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": "c3382702-b2cc-4d14-8e4e-27fa9be07923",
"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-01-14T05:18:01.1611072+00:00"
},
"work_instruction_details_id": "d51f9b7d-d327-4553-9e18-06c28aa8f46b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c4ac94ff-379d-4a1f-96ef-d8876275cc71",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3d9b9a63-7c92-4971-8ea8-9a66d01d2970",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-14T05:18:01.1611072+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": "7514c4d1-4046-4de5-9f03-7db4bd0d3b99",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-14T05:18:01.1611072+00:00"
}