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": "90dad2f6-6463-4e17-aaa7-07a4c97cccea",
"jobs_id": "743dc0d6-6cd0-4bbb-8ae4-b2323670e9f5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "19130691-055e-416b-a353-bfe40ac74c21",
"_parent_id": "9d48133b-c049-4d63-8fc0-d181d02d176c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fb6dfee2-6693-4213-b52b-8ee987a633cc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0bed86f1-db91-4b01-892c-612a0c006ba6",
"_parent_id": "9e3aec51-95b6-4988-8bc9-7b973f5a866a",
"root_parent_id": "698b8a31-ea3d-418a-a496-5a09b0b7e645",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "20c3d00c-aa23-4df2-8bad-b907ac8a3159",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3b6dc0e9-6eeb-41a4-b44a-2c1b6d64a37c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e1bea064-130a-4e64-9e96-b80957fde7d2",
"_parent_code": "sample string 6",
"sales_organization_id": "387ad7eb-a8b4-406b-9054-3bd1c599f594",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "de3ba1d0-c86a-4484-aef1-199a2005fb3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c9dc55-3caf-41db-9aab-ccbae335078f",
"db_currency_id": "8ed1b949-2f0d-418d-a93c-92d50d49b80b",
"db_language_id": "67c3d52f-5106-4e0b-b7b8-6725270716c0",
"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-05T19:42:58.0134713+00:00"
},
"modified_dateutc": "2026-01-05T19:42:58.0134713+00:00"
},
"equipment_model_id": "f29d2919-c9fb-445e-b708-2f96a9b26d88",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1b8ffdee-01ee-4aba-9439-65fd34d7e285",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ab308ce3-3a45-45a9-84b2-3fb7fa6cbded",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c5aee1d3-a277-4038-87f4-7ee758c09059",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ae700aaa-ac13-463e-aa23-62b0eef49a67",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "de3ba1d0-c86a-4484-aef1-199a2005fb3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c9dc55-3caf-41db-9aab-ccbae335078f",
"db_currency_id": "8ed1b949-2f0d-418d-a93c-92d50d49b80b",
"db_language_id": "67c3d52f-5106-4e0b-b7b8-6725270716c0",
"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-05T19:42:58.0134713+00:00"
},
"modified_dateutc": "2026-01-05T19:42:58.0134713+00:00"
},
"equipment_family_id": "4c01173c-7ad9-4e51-9152-1b422cead14a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3b6dc0e9-6eeb-41a4-b44a-2c1b6d64a37c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e1bea064-130a-4e64-9e96-b80957fde7d2",
"_parent_code": "sample string 6",
"sales_organization_id": "387ad7eb-a8b4-406b-9054-3bd1c599f594",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "de3ba1d0-c86a-4484-aef1-199a2005fb3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c9dc55-3caf-41db-9aab-ccbae335078f",
"db_currency_id": "8ed1b949-2f0d-418d-a93c-92d50d49b80b",
"db_language_id": "67c3d52f-5106-4e0b-b7b8-6725270716c0",
"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-05T19:42:58.0134713+00:00"
},
"modified_dateutc": "2026-01-05T19:42:58.0134713+00:00"
},
"date_in_production_since": "2026-01-05T19:42:58.0134713+00:00",
"date_out_of_production_since": "2026-01-05T19:42:58.0134713+00:00",
"date_end_support": "2026-01-05T19:42:58.0134713+00:00",
"sales_organization_id": "106c37ec-d85e-4846-adcd-0896d87405b6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "de3ba1d0-c86a-4484-aef1-199a2005fb3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c9dc55-3caf-41db-9aab-ccbae335078f",
"db_currency_id": "8ed1b949-2f0d-418d-a93c-92d50d49b80b",
"db_language_id": "67c3d52f-5106-4e0b-b7b8-6725270716c0",
"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-05T19:42:58.0134713+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-05T19:42:58.0134713+00:00"
},
"project_status_id": "7e3154ad-0cb8-45b5-b07f-2244923464d9",
"project_status_code": "sample string 10",
"project_status": {
"id": "f3e8ec14-1f62-4e21-90fd-bb0096a6cc05",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bbe44ed9-3239-44f0-8fe5-8f41436108e3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "de3ba1d0-c86a-4484-aef1-199a2005fb3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c9dc55-3caf-41db-9aab-ccbae335078f",
"db_currency_id": "8ed1b949-2f0d-418d-a93c-92d50d49b80b",
"db_language_id": "67c3d52f-5106-4e0b-b7b8-6725270716c0",
"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-05T19:42:58.0134713+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-05T19:42:58.0134713+00:00"
},
"company_id": "e6cc89fe-72ca-41c6-9e56-48b2f9b8e290",
"company_code": "sample string 12",
"db_address_id": "6a0eeb44-5bec-4c97-8b43-8702a72eebed",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9869bfdc-0fba-4225-bf67-05eb3e5f27ee",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cae23c94-9064-4f40-a024-b71cd59eb135",
"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-05T19:42:58.0134713+00:00",
"date_create": "2026-01-05T19:42:58.0134713+00:00",
"date_update": "2026-01-05T19:42:58.0134713+00:00",
"updated_by_user_id": "f2ca3c74-05d0-4f9e-9c50-899043b38fe0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-05T19:42:58.0134713+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-05T19:42:58.0134713+00:00",
"date_last_job": "2026-01-05T19:42:58.0134713+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-05T19:42:58.0134713+00:00",
"modified_dateutc": "2026-01-05T19:42:58.0134713+00:00",
"is_mobile_installation": true
},
"job_type_id": "fd6e10a1-38e1-43d0-baa6-ece4a9dd07ed",
"job_type_code": "sample string 7",
"job_type": {
"id": "03fcb551-2c17-4f10-8de4-e2540b540606",
"name": "sample string 2",
"sales_organization_id": "ad04a2b9-7fb7-4997-8bf6-5666e20f6e55",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-05T19:42:58.0134713+00:00",
"code": "sample string 7"
},
"job_priority_id": "97198cb0-ce05-4217-82f9-6462c251af53",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0b26f0a8-54b5-43f9-86ae-04697543c0d8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a7158e83-c2b4-43ce-96e7-abba6e626ce4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "de3ba1d0-c86a-4484-aef1-199a2005fb3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c9dc55-3caf-41db-9aab-ccbae335078f",
"db_currency_id": "8ed1b949-2f0d-418d-a93c-92d50d49b80b",
"db_language_id": "67c3d52f-5106-4e0b-b7b8-6725270716c0",
"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-05T19:42:58.0134713+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-05T19:42:58.0134713+00:00"
},
"job_status_id": "e5ad0f74-b84a-43bc-942b-624ec876fb1b",
"job_status_code": "sample string 11",
"db_address_id": "907104c0-f470-465b-a219-b96c81c54781",
"contact_id": "cfa86617-8a0c-41d5-be4c-f58e030ff28d",
"requested_by_company_id": "12e593b0-5957-4d78-be96-0cc9e74b6632",
"requested_by_contact_id": "40c7bd9f-fc8b-42dd-ada9-885856735f90",
"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-05T19:42:58.0290969+00:00",
"due_date": "2026-01-05T19:42:58.0290969+00:00",
"date_create": "2026-01-05T19:42:58.0290969+00:00",
"date_update": "2026-01-05T19:42:58.0290969+00:00",
"date_closed": "2026-01-05T19:42:58.0290969+00:00",
"suggested_user_id": "a0ea8aef-ad98-4684-b3ab-1a74927b61f6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "552cc9dd-07f2-476a-aaf1-be0039b33080",
"db_language_id": "5395e14c-a21d-44fa-93b9-3d29d426e93d",
"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-05T19:42:58.0290969+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d66a1bea-65c3-46c2-8829-23ee2ffed5ae",
"sales_organization": {
"id": "de3ba1d0-c86a-4484-aef1-199a2005fb3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c9dc55-3caf-41db-9aab-ccbae335078f",
"db_currency_id": "8ed1b949-2f0d-418d-a93c-92d50d49b80b",
"db_language_id": "67c3d52f-5106-4e0b-b7b8-6725270716c0",
"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-05T19:42:58.0134713+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "362cc4af-0934-41b1-8cdf-55308b8fd1d5",
"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": "6c7137b4-4587-40fa-ab94-f65adcc97760",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-05T19:42:58.0290969+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3a480294-e884-4a66-b97b-e91644be76fa"
},
"suggested_date_start": "2026-01-05T19:42:58.0290969+00:00",
"skill_id": "bbb363e0-732f-4409-ad73-3994d3d11cf2",
"skill_code": "sample string 32",
"skill": {
"id": "79593180-c832-4256-ab06-9017e5be81db",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2471011b-8885-477b-83ed-3f1e730eac45",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "de3ba1d0-c86a-4484-aef1-199a2005fb3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c9dc55-3caf-41db-9aab-ccbae335078f",
"db_currency_id": "8ed1b949-2f0d-418d-a93c-92d50d49b80b",
"db_language_id": "67c3d52f-5106-4e0b-b7b8-6725270716c0",
"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-05T19:42:58.0134713+00:00"
},
"modified_dateutc": "2026-01-05T19:42:58.0290969+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3c3e9d34-2987-4620-8255-e57529a53020",
"date_reported_by_company": "2026-01-05T19:42:58.0290969+00:00",
"id2": 36,
"company_id": "6a536eae-1482-4adb-b34c-bec999e8353a",
"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": "9fb9c291-c12d-464c-9117-500c01771ffa",
"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-05T19:42:58.0290969+00:00"
},
"work_instruction_details_id": "b0a1a795-8d33-44de-8419-54cad559e244",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e090e066-a436-4ebf-8d89-38415073894c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "77546812-f136-47a1-b641-2e217078c533",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-05T19:42:58.0290969+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": "4332f36a-f3e5-417e-992f-462799859174",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-05T19:42:58.0290969+00:00"
}