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": "ea551189-03d6-4267-b38d-59d3109ee878",
"jobs_id": "97653636-54e7-4677-9616-3b585b4b9b55",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "973e07c0-baf6-4d26-a9ce-6fa5dfa45239",
"_parent_id": "bee4aefa-554e-4e46-bb90-780f1c3767fe",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8e93673c-a4e5-4f9f-b218-a81d5a362923",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9aaacc08-17fe-4002-b760-d7a754e638b2",
"_parent_id": "5efa4aaa-9eb2-41f4-bc15-b3402193a049",
"root_parent_id": "9138c5a7-1c3d-4a0a-8853-1aba99622d48",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "aba79e70-2c9f-48ba-8e24-7d39fa51ffb6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "06d40173-ab8a-4f4e-831d-a31abcc5fd86",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "694bdfa1-edd3-4504-9af8-189f77708823",
"_parent_code": "sample string 6",
"sales_organization_id": "aab4b655-0bbf-4296-95e9-a7e3cff29535",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3841f661-75e4-4b65-907d-2142e316ba52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8de557b0-296c-4d3e-a8ce-083ebd40d212",
"db_currency_id": "c46786d0-daa7-461a-9063-d4c8d203fc29",
"db_language_id": "2c38002f-5dd6-4c97-9bb3-04ddb9992d86",
"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-03-10T09:50:11.8944426+00:00"
},
"modified_dateutc": "2026-03-10T09:50:11.8944426+00:00"
},
"equipment_model_id": "70868180-2b22-4762-a7fa-91350bf2424c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e6b5ba30-eb4c-48cd-be5f-5e0d440b5cb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5c5981ed-dc31-439d-b0bb-b8b942c97105",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "76baf373-985f-4d59-b178-19419eb2b30b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6e1dbce7-3724-41a6-a713-5b3b9121aab3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3841f661-75e4-4b65-907d-2142e316ba52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8de557b0-296c-4d3e-a8ce-083ebd40d212",
"db_currency_id": "c46786d0-daa7-461a-9063-d4c8d203fc29",
"db_language_id": "2c38002f-5dd6-4c97-9bb3-04ddb9992d86",
"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-03-10T09:50:11.8944426+00:00"
},
"modified_dateutc": "2026-03-10T09:50:11.8944426+00:00"
},
"equipment_family_id": "e8343678-b16e-4af6-a70a-7dcb90c40a98",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "06d40173-ab8a-4f4e-831d-a31abcc5fd86",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "694bdfa1-edd3-4504-9af8-189f77708823",
"_parent_code": "sample string 6",
"sales_organization_id": "aab4b655-0bbf-4296-95e9-a7e3cff29535",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3841f661-75e4-4b65-907d-2142e316ba52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8de557b0-296c-4d3e-a8ce-083ebd40d212",
"db_currency_id": "c46786d0-daa7-461a-9063-d4c8d203fc29",
"db_language_id": "2c38002f-5dd6-4c97-9bb3-04ddb9992d86",
"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-03-10T09:50:11.8944426+00:00"
},
"modified_dateutc": "2026-03-10T09:50:11.8944426+00:00"
},
"date_in_production_since": "2026-03-10T09:50:11.8944426+00:00",
"date_out_of_production_since": "2026-03-10T09:50:11.8944426+00:00",
"date_end_support": "2026-03-10T09:50:11.8944426+00:00",
"sales_organization_id": "0d762342-ab6e-4c11-940f-8760dd25d571",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3841f661-75e4-4b65-907d-2142e316ba52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8de557b0-296c-4d3e-a8ce-083ebd40d212",
"db_currency_id": "c46786d0-daa7-461a-9063-d4c8d203fc29",
"db_language_id": "2c38002f-5dd6-4c97-9bb3-04ddb9992d86",
"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-03-10T09:50:11.8944426+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-03-10T09:50:11.8944426+00:00"
},
"project_status_id": "d04b3d2b-81c4-41f4-97ee-73ed79bf77d4",
"project_status_code": "sample string 10",
"project_status": {
"id": "3bf26793-4238-4e8f-afec-26a2ae008024",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "05619aa6-599a-4848-a757-00bc88bcb711",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3841f661-75e4-4b65-907d-2142e316ba52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8de557b0-296c-4d3e-a8ce-083ebd40d212",
"db_currency_id": "c46786d0-daa7-461a-9063-d4c8d203fc29",
"db_language_id": "2c38002f-5dd6-4c97-9bb3-04ddb9992d86",
"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-03-10T09:50:11.8944426+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-10T09:50:11.8944426+00:00"
},
"company_id": "dcee7c86-2056-4f31-b347-55218acc1317",
"company_code": "sample string 12",
"db_address_id": "4a9d977a-29aa-4852-8f94-13080243619b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0cc3b92f-0e54-4dbc-b795-9c7a192225d0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8a957534-8586-4018-8cfd-1695ea2b783c",
"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-03-10T09:50:11.8944426+00:00",
"date_create": "2026-03-10T09:50:11.8944426+00:00",
"date_update": "2026-03-10T09:50:11.8944426+00:00",
"updated_by_user_id": "3b1ad76c-cbe0-4d63-9e28-85fa9a88ce4f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-10T09:50:11.8944426+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-03-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-10T09:50:11.8944426+00:00",
"date_last_job": "2026-03-10T09:50:11.8944426+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-10T09:50:11.8944426+00:00",
"modified_dateutc": "2026-03-10T09:50:11.8944426+00:00",
"is_mobile_installation": true
},
"job_type_id": "fd0fce99-db94-4775-8e6b-45031f82c6e2",
"job_type_code": "sample string 7",
"job_type": {
"id": "9f19101d-a17e-48d0-b5b2-32faaca1ff89",
"name": "sample string 2",
"sales_organization_id": "162b3848-b599-4558-821d-d9841ee16092",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-10T09:50:11.8944426+00:00",
"code": "sample string 7"
},
"job_priority_id": "fd65ec86-4ef7-4029-9d9d-44ce1beeba7a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ace986d9-b354-4c6d-bd24-dd9ee21a6bb6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7e45e66f-05a3-4333-8d20-74c4ab221cf0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3841f661-75e4-4b65-907d-2142e316ba52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8de557b0-296c-4d3e-a8ce-083ebd40d212",
"db_currency_id": "c46786d0-daa7-461a-9063-d4c8d203fc29",
"db_language_id": "2c38002f-5dd6-4c97-9bb3-04ddb9992d86",
"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-03-10T09:50:11.8944426+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-10T09:50:11.8944426+00:00"
},
"job_status_id": "02deb57c-3825-4591-902c-c540bb5955e5",
"job_status_code": "sample string 11",
"db_address_id": "c76e8d4a-af50-41d8-8c32-2e1ce9c6ccea",
"contact_id": "ee68d72d-5841-4c00-a126-b357767a5d33",
"requested_by_company_id": "75a00ebd-01ef-4b4b-a0e1-0e3aca32308f",
"requested_by_contact_id": "e8338440-0dc9-4eec-8f96-384ae7f75027",
"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-03-10T09:50:11.8944426+00:00",
"due_date": "2026-03-10T09:50:11.8944426+00:00",
"date_create": "2026-03-10T09:50:11.8944426+00:00",
"date_update": "2026-03-10T09:50:11.8944426+00:00",
"date_closed": "2026-03-10T09:50:11.8944426+00:00",
"suggested_user_id": "a3490ff4-01ba-4083-8c61-3bbc79602ff9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dbe42e21-2089-4f05-9c0e-7a41ecd1120f",
"db_language_id": "e2f8a94b-b61b-4892-b124-de6cf76305bd",
"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-03-10T09:50:11.8944426+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6a1945ce-8124-4f6c-a311-94ce35834588",
"sales_organization": {
"id": "3841f661-75e4-4b65-907d-2142e316ba52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8de557b0-296c-4d3e-a8ce-083ebd40d212",
"db_currency_id": "c46786d0-daa7-461a-9063-d4c8d203fc29",
"db_language_id": "2c38002f-5dd6-4c97-9bb3-04ddb9992d86",
"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-03-10T09:50:11.8944426+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f64ffc41-7cde-4e52-9605-3a862bc54263",
"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": "fb052a2f-78d5-4548-815a-121425b18fa9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-10T09:50:11.8944426+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c5baa526-cc05-4825-bde2-f074563b8855"
},
"suggested_date_start": "2026-03-10T09:50:11.8944426+00:00",
"skill_id": "9c92b8ca-f5bf-4d03-8d8b-6dda93be2126",
"skill_code": "sample string 32",
"skill": {
"id": "48d21ec7-417a-4ad4-91e8-291d82ab60fd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a2bbe400-a88d-49f6-909f-cec464c46c9f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3841f661-75e4-4b65-907d-2142e316ba52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8de557b0-296c-4d3e-a8ce-083ebd40d212",
"db_currency_id": "c46786d0-daa7-461a-9063-d4c8d203fc29",
"db_language_id": "2c38002f-5dd6-4c97-9bb3-04ddb9992d86",
"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-03-10T09:50:11.8944426+00:00"
},
"modified_dateutc": "2026-03-10T09:50:11.8944426+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "415e1eaa-90d0-467a-bedd-54d0736bb531",
"date_reported_by_company": "2026-03-10T09:50:11.8944426+00:00",
"id2": 36,
"company_id": "b6c1b84e-851f-40bf-aa4c-b58022408407",
"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": "180220bd-fb31-4d6b-bf03-bbe44b0cbf84",
"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-03-10T09:50:11.8944426+00:00"
},
"work_instruction_details_id": "a2de9739-76d0-4961-9c6a-04630125a63c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1cd584c3-a541-47b5-ae72-e8073f365016",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ea6e66ab-9b70-467a-b51d-4fee0eb888e1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-10T09:50:11.8944426+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": "6c56066a-247b-4087-ac14-d79663e2fbb0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-10T09:50:11.8944426+00:00"
}