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": "8a212b73-3cff-4208-ace4-0c8fefd4eb16",
"jobs_id": "6d85dd97-6cde-4b41-a0aa-559928ce14c9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5a045910-af56-4e4e-83f4-3374e344b16d",
"_parent_id": "b8199bba-784b-4133-8e9f-06e2173c6a23",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5dc1b986-faaf-4818-98b1-2964fb5bc228",
"project_reference_back_office": "sample string 5",
"project": {
"id": "48207e62-da6b-4d98-88f7-066cef1d7a27",
"_parent_id": "fdecae81-9950-4069-8fa0-09465fa7a221",
"root_parent_id": "dbffe4fb-6d56-4f75-ae18-f6eee3e4d364",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e9e0da96-878a-43ce-856f-0fe43ea415a3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c491f53d-d7bd-4c14-917e-c7a0cdc07b0f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "09787fce-16a8-4a11-aca8-54effda338e5",
"_parent_code": "sample string 6",
"sales_organization_id": "0f4b26f2-158f-4633-9548-4b6e159caf6e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7ad9c7ef-02e5-43f0-8f2b-c539d053cbb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54564c53-b649-4eb6-8105-77a47feef738",
"db_currency_id": "cd34ed7c-c0d1-4adc-b5a7-e4f96ba7b3be",
"db_language_id": "f5732b77-be01-4f4f-8ae2-e200d6b46c2e",
"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-10-06T21:35:44.5640814+00:00"
},
"modified_dateutc": "2026-10-06T21:35:44.5640814+00:00"
},
"equipment_model_id": "f2e2b8cc-f19e-4a53-bc2a-80afde38d52e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2466653d-09c0-4b00-9452-a907fd466f40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8f91e43f-2e62-4072-bdca-a2eac734dfeb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8e029667-5aaf-4a06-adce-9e023a94a6c2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "956546aa-98d1-4b97-aabf-781db2593fb7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7ad9c7ef-02e5-43f0-8f2b-c539d053cbb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54564c53-b649-4eb6-8105-77a47feef738",
"db_currency_id": "cd34ed7c-c0d1-4adc-b5a7-e4f96ba7b3be",
"db_language_id": "f5732b77-be01-4f4f-8ae2-e200d6b46c2e",
"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-10-06T21:35:44.5640814+00:00"
},
"modified_dateutc": "2026-10-06T21:35:44.5640814+00:00"
},
"equipment_family_id": "1c14b327-b010-4cf1-9b3f-1c0d40e02e9f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c491f53d-d7bd-4c14-917e-c7a0cdc07b0f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "09787fce-16a8-4a11-aca8-54effda338e5",
"_parent_code": "sample string 6",
"sales_organization_id": "0f4b26f2-158f-4633-9548-4b6e159caf6e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7ad9c7ef-02e5-43f0-8f2b-c539d053cbb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54564c53-b649-4eb6-8105-77a47feef738",
"db_currency_id": "cd34ed7c-c0d1-4adc-b5a7-e4f96ba7b3be",
"db_language_id": "f5732b77-be01-4f4f-8ae2-e200d6b46c2e",
"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-10-06T21:35:44.5640814+00:00"
},
"modified_dateutc": "2026-10-06T21:35:44.5640814+00:00"
},
"date_in_production_since": "2026-10-06T21:35:44.5640814+00:00",
"date_out_of_production_since": "2026-10-06T21:35:44.5640814+00:00",
"date_end_support": "2026-10-06T21:35:44.5640814+00:00",
"sales_organization_id": "835c7d25-1675-4e45-bdbb-d663c8018d5f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7ad9c7ef-02e5-43f0-8f2b-c539d053cbb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54564c53-b649-4eb6-8105-77a47feef738",
"db_currency_id": "cd34ed7c-c0d1-4adc-b5a7-e4f96ba7b3be",
"db_language_id": "f5732b77-be01-4f4f-8ae2-e200d6b46c2e",
"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-10-06T21:35:44.5640814+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-10-06T21:35:44.5640814+00:00"
},
"project_status_id": "a32805c1-e786-4632-8d51-e91676aebe0f",
"project_status_code": "sample string 10",
"project_status": {
"id": "fe67bf75-7fc7-4bca-b5f1-b3b4fa0f5a91",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b200755d-08d2-409a-b946-ad8f80f2cb9d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7ad9c7ef-02e5-43f0-8f2b-c539d053cbb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54564c53-b649-4eb6-8105-77a47feef738",
"db_currency_id": "cd34ed7c-c0d1-4adc-b5a7-e4f96ba7b3be",
"db_language_id": "f5732b77-be01-4f4f-8ae2-e200d6b46c2e",
"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-10-06T21:35:44.5640814+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T21:35:44.5640814+00:00"
},
"company_id": "a0ce3c8a-9bd7-4ee1-aa76-edfb5819ab05",
"company_code": "sample string 12",
"db_address_id": "81306194-18b8-4230-a74a-f00d1871d06f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3ef4290e-7efb-4989-b390-558013dc3371",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "05049260-37b6-4382-b3fb-9dda02d2669b",
"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-10-06T21:35:44.5640814+00:00",
"date_create": "2026-10-06T21:35:44.5640814+00:00",
"date_update": "2026-10-06T21:35:44.5640814+00:00",
"updated_by_user_id": "371c9e4e-c4f8-4f47-938a-c9a6fd0d3a0e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-06T21:35:44.5640814+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-10-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-06T21:35:44.5640814+00:00",
"date_last_job": "2026-10-06T21:35:44.5640814+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-06T21:35:44.5640814+00:00",
"modified_dateutc": "2026-10-06T21:35:44.5640814+00:00",
"is_mobile_installation": true
},
"job_type_id": "4b52a8d1-68c4-4302-b2c4-69742ab5937e",
"job_type_code": "sample string 7",
"job_type": {
"id": "15e889a5-ae41-41df-8875-3784157f208e",
"name": "sample string 2",
"sales_organization_id": "2c36052f-10ce-4e27-8a8f-e7443433041c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-06T21:35:44.5640814+00:00",
"code": "sample string 7"
},
"job_priority_id": "173ff199-dc0a-41f8-85e9-cb629c9b1d62",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c03c358e-82a2-46fa-8230-5a2f24935aef",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "87abb82d-81b0-443d-84b0-cdb0f5b35964",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7ad9c7ef-02e5-43f0-8f2b-c539d053cbb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54564c53-b649-4eb6-8105-77a47feef738",
"db_currency_id": "cd34ed7c-c0d1-4adc-b5a7-e4f96ba7b3be",
"db_language_id": "f5732b77-be01-4f4f-8ae2-e200d6b46c2e",
"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-10-06T21:35:44.5640814+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T21:35:44.5640814+00:00"
},
"job_status_id": "1b35213f-72dc-418e-8b82-48cd693070d5",
"job_status_code": "sample string 11",
"db_address_id": "b05b4519-3896-4161-9267-f24f5a6ac1b8",
"contact_id": "044da24b-ce9a-4073-bbff-2f2e3fe32311",
"requested_by_company_id": "d7327b35-6d4a-41e4-81fe-fc93339919cf",
"requested_by_contact_id": "d2437fcc-2623-461b-8749-f24146e49b94",
"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-10-06T21:35:44.5640814+00:00",
"due_date": "2026-10-06T21:35:44.5640814+00:00",
"date_create": "2026-10-06T21:35:44.5640814+00:00",
"date_update": "2026-10-06T21:35:44.5640814+00:00",
"date_closed": "2026-10-06T21:35:44.5640814+00:00",
"suggested_user_id": "99e75ea1-7f68-45fb-b03b-5361ec3c2392",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1d8e7e3f-0ebe-4c8c-b152-6cb963369f62",
"db_language_id": "291990d0-904f-43ae-83ef-1725e7fe1854",
"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-10-06T21:35:44.5640814+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "793d6c9f-48f5-4d48-9261-8fb674e1c47b",
"sales_organization": {
"id": "7ad9c7ef-02e5-43f0-8f2b-c539d053cbb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54564c53-b649-4eb6-8105-77a47feef738",
"db_currency_id": "cd34ed7c-c0d1-4adc-b5a7-e4f96ba7b3be",
"db_language_id": "f5732b77-be01-4f4f-8ae2-e200d6b46c2e",
"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-10-06T21:35:44.5640814+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b51c88c3-129a-49db-8981-a2fb6f0c5d7a",
"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": "4b4e6a44-0157-453e-984a-bf056f441a81",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-06T21:35:44.5640814+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6e818fb5-fc4a-4586-9a0a-342546f8ed7f"
},
"suggested_date_start": "2026-10-06T21:35:44.5640814+00:00",
"skill_id": "32ce6495-5054-49bd-9e3c-6f83864d3a74",
"skill_code": "sample string 32",
"skill": {
"id": "879f7e63-db13-401c-9bad-5d9d45fba98e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6c866e0f-1e86-4650-82d5-1437f6b444ee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7ad9c7ef-02e5-43f0-8f2b-c539d053cbb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54564c53-b649-4eb6-8105-77a47feef738",
"db_currency_id": "cd34ed7c-c0d1-4adc-b5a7-e4f96ba7b3be",
"db_language_id": "f5732b77-be01-4f4f-8ae2-e200d6b46c2e",
"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-10-06T21:35:44.5640814+00:00"
},
"modified_dateutc": "2026-10-06T21:35:44.5640814+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "de9fbaad-6cde-4c67-bd59-12d655085438",
"date_reported_by_company": "2026-10-06T21:35:44.5640814+00:00",
"id2": 36,
"company_id": "fc371bf8-ddde-4970-92ec-fd8e0448907a",
"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": "3c3b627a-1383-4289-b903-058164686f13",
"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-10-06T21:35:44.5640814+00:00"
},
"work_instruction_details_id": "bc9f041d-da97-43d8-be4d-99d1970d6435",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "36b27f29-a91b-4c40-a00f-292712393b28",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "57dc4d6e-afde-47bf-9f98-a09c87414e82",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-06T21:35:44.5640814+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": "acf30c12-f69a-43d9-9119-81ca955fe7af",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-06T21:35:44.5640814+00:00"
}