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": "49b5ceae-dbb8-45a7-9d4f-eb99c182261c",
"jobs_id": "fbf5be90-84cc-44c0-bab6-ff65e92f1f18",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "720f4ce8-b5a6-48cc-aee9-e36e3cab350f",
"_parent_id": "100ad6c5-2208-4005-aee4-919d024dcd81",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2695608e-e49a-4a01-b74c-d55540a1b20f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "35739f91-adba-4915-a607-b8f75cb18089",
"_parent_id": "5af3b870-ede3-4c18-b89d-93f84e1baf84",
"root_parent_id": "8baafd91-304e-498e-9e5d-16c1a21cea13",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "de459370-fd95-47c9-9efd-de97f780da4c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "90ee4015-a78e-4e12-86f2-8e69ff06d702",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "777c2a0f-c39c-4372-85e9-8485e602eda1",
"_parent_code": "sample string 6",
"sales_organization_id": "718ddc2b-5055-4112-a0ae-cc80cbe7e6bf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fac2269e-0449-4134-b59c-65b1df7f6c9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7d50150-00ee-4787-b558-daa08bc62526",
"db_currency_id": "cb4a21b9-5f56-475c-b38f-9421b086bb84",
"db_language_id": "15830ab9-2327-443f-9436-867a551fdf04",
"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-06-06T17:00:13.4170727+00:00"
},
"modified_dateutc": "2026-06-06T17:00:13.4170727+00:00"
},
"equipment_model_id": "afb0aea2-3ce0-440c-b709-863c4e92b3cf",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "77538990-c021-4871-abf1-0e377f601a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "85267711-7bd8-4bd4-8890-87ffa246d63b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f9cf2960-4837-47b0-8b24-ebd0cf00d092",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5ad6f526-e8c5-4c72-b3e7-cb4ffc3001de",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fac2269e-0449-4134-b59c-65b1df7f6c9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7d50150-00ee-4787-b558-daa08bc62526",
"db_currency_id": "cb4a21b9-5f56-475c-b38f-9421b086bb84",
"db_language_id": "15830ab9-2327-443f-9436-867a551fdf04",
"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-06-06T17:00:13.4170727+00:00"
},
"modified_dateutc": "2026-06-06T17:00:13.4170727+00:00"
},
"equipment_family_id": "5cdaaec0-ab46-4045-9b77-2a3b66c1bd46",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "90ee4015-a78e-4e12-86f2-8e69ff06d702",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "777c2a0f-c39c-4372-85e9-8485e602eda1",
"_parent_code": "sample string 6",
"sales_organization_id": "718ddc2b-5055-4112-a0ae-cc80cbe7e6bf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fac2269e-0449-4134-b59c-65b1df7f6c9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7d50150-00ee-4787-b558-daa08bc62526",
"db_currency_id": "cb4a21b9-5f56-475c-b38f-9421b086bb84",
"db_language_id": "15830ab9-2327-443f-9436-867a551fdf04",
"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-06-06T17:00:13.4170727+00:00"
},
"modified_dateutc": "2026-06-06T17:00:13.4170727+00:00"
},
"date_in_production_since": "2026-06-06T17:00:13.4170727+00:00",
"date_out_of_production_since": "2026-06-06T17:00:13.4170727+00:00",
"date_end_support": "2026-06-06T17:00:13.4170727+00:00",
"sales_organization_id": "1da1a202-84ac-4809-94e9-cc83f39654bc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fac2269e-0449-4134-b59c-65b1df7f6c9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7d50150-00ee-4787-b558-daa08bc62526",
"db_currency_id": "cb4a21b9-5f56-475c-b38f-9421b086bb84",
"db_language_id": "15830ab9-2327-443f-9436-867a551fdf04",
"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-06-06T17:00:13.4170727+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-06-06T17:00:13.4326879+00:00"
},
"project_status_id": "d7eeee53-2da7-4444-b1c0-a1e291056cea",
"project_status_code": "sample string 10",
"project_status": {
"id": "c935a872-0d3f-42d1-9728-3b0b042c9599",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a786ee8f-81d6-4c7c-8639-885895aa69c6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fac2269e-0449-4134-b59c-65b1df7f6c9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7d50150-00ee-4787-b558-daa08bc62526",
"db_currency_id": "cb4a21b9-5f56-475c-b38f-9421b086bb84",
"db_language_id": "15830ab9-2327-443f-9436-867a551fdf04",
"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-06-06T17:00:13.4170727+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-06T17:00:13.4326879+00:00"
},
"company_id": "df22aae1-e456-4102-972a-d3139812138e",
"company_code": "sample string 12",
"db_address_id": "efcc75b9-00d0-473b-81fa-e2c222f5d55d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d3755383-2a5e-44a6-9a77-24be9913dc46",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "149be5b7-3f24-4c67-b2a5-52483f6ae9a2",
"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-06-06T17:00:13.4326879+00:00",
"date_create": "2026-06-06T17:00:13.4326879+00:00",
"date_update": "2026-06-06T17:00:13.4326879+00:00",
"updated_by_user_id": "0294f8a2-858d-4560-9976-8c1e8fd91b35",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-06T17:00:13.4326879+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-06-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-06T17:00:13.4326879+00:00",
"date_last_job": "2026-06-06T17:00:13.4326879+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-06T17:00:13.4326879+00:00",
"modified_dateutc": "2026-06-06T17:00:13.4326879+00:00",
"is_mobile_installation": true
},
"job_type_id": "4d6b93ef-09c8-40a9-a514-fc71f789b510",
"job_type_code": "sample string 7",
"job_type": {
"id": "d6ee61ed-a81f-49e5-b447-e291c4634f72",
"name": "sample string 2",
"sales_organization_id": "8d376117-5f94-458e-8301-f0f0686429fb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-06T17:00:13.4326879+00:00",
"code": "sample string 7"
},
"job_priority_id": "d67fed19-53da-40cb-b9f9-dc482e544407",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "601fc7de-3045-46ce-8631-f2d6191f2854",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "224681d7-5211-407d-b98c-4a39260554e0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fac2269e-0449-4134-b59c-65b1df7f6c9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7d50150-00ee-4787-b558-daa08bc62526",
"db_currency_id": "cb4a21b9-5f56-475c-b38f-9421b086bb84",
"db_language_id": "15830ab9-2327-443f-9436-867a551fdf04",
"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-06-06T17:00:13.4170727+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-06T17:00:13.4326879+00:00"
},
"job_status_id": "019d326b-6c2c-44fe-b189-7931ff5eb7fa",
"job_status_code": "sample string 11",
"db_address_id": "d442759a-666f-43f0-8f4d-bad2c47402b1",
"contact_id": "13708610-aea3-49cc-944e-58ce017b8ef6",
"requested_by_company_id": "8cfa6dd1-c068-49b9-8985-84115669b8da",
"requested_by_contact_id": "f6ff9140-04d1-4e1d-b212-e982c3bbd9ef",
"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-06-06T17:00:13.4326879+00:00",
"due_date": "2026-06-06T17:00:13.4326879+00:00",
"date_create": "2026-06-06T17:00:13.4326879+00:00",
"date_update": "2026-06-06T17:00:13.4326879+00:00",
"date_closed": "2026-06-06T17:00:13.4326879+00:00",
"suggested_user_id": "216e3f1c-4549-446b-a8ca-09b182862ef9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ef8f84b8-800b-430f-860d-92b4799d8c52",
"db_language_id": "efb3ac4e-7fbc-4b5a-99a8-3a36f410ba20",
"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-06-06T17:00:13.4326879+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fb3a90a9-4f8b-44aa-a65a-c82055e05165",
"sales_organization": {
"id": "fac2269e-0449-4134-b59c-65b1df7f6c9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7d50150-00ee-4787-b558-daa08bc62526",
"db_currency_id": "cb4a21b9-5f56-475c-b38f-9421b086bb84",
"db_language_id": "15830ab9-2327-443f-9436-867a551fdf04",
"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-06-06T17:00:13.4170727+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "10ff7118-9dfa-4e97-9065-020d75d8c57e",
"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": "fede388f-ddae-4889-a24a-ebfe4b24356c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-06T17:00:13.4326879+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "60e60798-a7a6-4b94-aa80-52e43a6801b8"
},
"suggested_date_start": "2026-06-06T17:00:13.4326879+00:00",
"skill_id": "b5d39c9e-d069-4a7a-805e-54adb210ea00",
"skill_code": "sample string 32",
"skill": {
"id": "9fa2678a-1b83-4782-a58c-9a5df6eaa53c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1c3a6504-a76d-46d9-960c-bad115f44bb1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fac2269e-0449-4134-b59c-65b1df7f6c9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7d50150-00ee-4787-b558-daa08bc62526",
"db_currency_id": "cb4a21b9-5f56-475c-b38f-9421b086bb84",
"db_language_id": "15830ab9-2327-443f-9436-867a551fdf04",
"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-06-06T17:00:13.4170727+00:00"
},
"modified_dateutc": "2026-06-06T17:00:13.4326879+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "04d683b9-37f8-44ca-9d6b-f137e7d3eadc",
"date_reported_by_company": "2026-06-06T17:00:13.4326879+00:00",
"id2": 36,
"company_id": "9f416e33-8ceb-4875-8f02-f75e1bde368c",
"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": "7e796c56-dae1-4c96-9473-9475770d0629",
"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-06-06T17:00:13.4326879+00:00"
},
"work_instruction_details_id": "832ff3d4-6e50-42e7-a9b7-bc4b090fe4b7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "222fd8c0-24dc-4aa5-9c33-358683dc2bbd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "77ab8ef4-b2fb-4fb6-8d22-067062c638c1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-06T17:00:13.4326879+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": "32b53cef-2f16-4111-8622-ccf83ba6ef71",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-06T17:00:13.4326879+00:00"
}