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": "b4c01308-159c-4674-bbb9-daa381e951b3",
"jobs_id": "92e8da8b-ef5e-40ad-a98a-5a90e6340cca",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6b06e574-c9a4-4adf-a8bd-319e7650fb35",
"_parent_id": "3d3ece77-7b3c-4352-902b-7f72d864f6a8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "755d191f-467d-419b-9df4-0b827f836dbf",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c5b94249-4cac-4a68-8355-d29b7d2dd193",
"_parent_id": "899a86df-69ed-49cb-bd41-cbffa76cc2ed",
"root_parent_id": "b5b2a07e-5264-4aa8-88f0-9ae5e00d73e4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ff571561-1beb-4b86-9206-f9612b1acb99",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "316d09d2-6621-46c4-b3a0-64319bdb33ed",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5e8ab7e7-c1c4-43d9-a50e-7aa5d77cc777",
"_parent_code": "sample string 6",
"sales_organization_id": "5cc9c419-d90c-4853-bba9-c4fd659e80d7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6583f845-3340-4520-8620-1b53154ad9e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1566265-cea0-4a3b-837d-9900eef77658",
"db_currency_id": "ad755bb8-17c1-49cd-a6b6-0c196ec56122",
"db_language_id": "68863a9b-e3dd-42c4-bcd1-dde2cf1eb40e",
"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-05-30T14:57:25.1664425+00:00"
},
"modified_dateutc": "2026-05-30T14:57:25.1664425+00:00"
},
"equipment_model_id": "90f77a41-59c7-43c1-82e4-a430154aa426",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fc1a231c-30dd-4a9c-8d34-35e85ef45cbe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "78b3f45d-7550-4959-8ea7-94e81c68eeba",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "53bf6090-f98c-42a1-8007-2802f50414f6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0d5b3af2-5cad-496d-8c8a-ec5478ed1f30",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6583f845-3340-4520-8620-1b53154ad9e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1566265-cea0-4a3b-837d-9900eef77658",
"db_currency_id": "ad755bb8-17c1-49cd-a6b6-0c196ec56122",
"db_language_id": "68863a9b-e3dd-42c4-bcd1-dde2cf1eb40e",
"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-05-30T14:57:25.1664425+00:00"
},
"modified_dateutc": "2026-05-30T14:57:25.1664425+00:00"
},
"equipment_family_id": "f3a1a196-51a8-48cd-9a99-e6769fa76be3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "316d09d2-6621-46c4-b3a0-64319bdb33ed",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5e8ab7e7-c1c4-43d9-a50e-7aa5d77cc777",
"_parent_code": "sample string 6",
"sales_organization_id": "5cc9c419-d90c-4853-bba9-c4fd659e80d7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6583f845-3340-4520-8620-1b53154ad9e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1566265-cea0-4a3b-837d-9900eef77658",
"db_currency_id": "ad755bb8-17c1-49cd-a6b6-0c196ec56122",
"db_language_id": "68863a9b-e3dd-42c4-bcd1-dde2cf1eb40e",
"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-05-30T14:57:25.1664425+00:00"
},
"modified_dateutc": "2026-05-30T14:57:25.1664425+00:00"
},
"date_in_production_since": "2026-05-30T14:57:25.1664425+00:00",
"date_out_of_production_since": "2026-05-30T14:57:25.1664425+00:00",
"date_end_support": "2026-05-30T14:57:25.1664425+00:00",
"sales_organization_id": "30334bba-7291-4ef5-bc40-6ce2f410041c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6583f845-3340-4520-8620-1b53154ad9e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1566265-cea0-4a3b-837d-9900eef77658",
"db_currency_id": "ad755bb8-17c1-49cd-a6b6-0c196ec56122",
"db_language_id": "68863a9b-e3dd-42c4-bcd1-dde2cf1eb40e",
"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-05-30T14:57:25.1664425+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-05-30T14:57:25.1664425+00:00"
},
"project_status_id": "9f227034-57d4-41c6-ad10-331f5831c550",
"project_status_code": "sample string 10",
"project_status": {
"id": "d60b9a63-14a6-4272-bd93-74ac68261ad3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "42ff2814-8704-4837-9c35-3f33f6a176d2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6583f845-3340-4520-8620-1b53154ad9e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1566265-cea0-4a3b-837d-9900eef77658",
"db_currency_id": "ad755bb8-17c1-49cd-a6b6-0c196ec56122",
"db_language_id": "68863a9b-e3dd-42c4-bcd1-dde2cf1eb40e",
"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-05-30T14:57:25.1664425+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T14:57:25.1664425+00:00"
},
"company_id": "b5cb7384-e85d-4c88-8226-d0a173261223",
"company_code": "sample string 12",
"db_address_id": "9c30bdb5-3bcd-40a8-8ba5-376413dcf9ad",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "caa0fea5-d2fd-4618-ab37-d55b85426a37",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "fccc208a-0c8a-413d-ba10-1b1d09c4a7bb",
"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-05-30T14:57:25.1664425+00:00",
"date_create": "2026-05-30T14:57:25.1664425+00:00",
"date_update": "2026-05-30T14:57:25.1664425+00:00",
"updated_by_user_id": "549563de-03da-4c9a-81a1-355b2c25fa4c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-30T14:57:25.1664425+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-05-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-30T14:57:25.1664425+00:00",
"date_last_job": "2026-05-30T14:57:25.1664425+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-30T14:57:25.1664425+00:00",
"modified_dateutc": "2026-05-30T14:57:25.1664425+00:00",
"is_mobile_installation": true
},
"job_type_id": "ed448ac7-3c0a-4a6c-905b-3c734d7f91e6",
"job_type_code": "sample string 7",
"job_type": {
"id": "da98307f-78e9-4181-bfaf-a4d721076b04",
"name": "sample string 2",
"sales_organization_id": "e68f6ef8-b448-4d62-8537-d43309398ed6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-30T14:57:25.1664425+00:00",
"code": "sample string 7"
},
"job_priority_id": "65809f4e-0e27-4fce-9cde-155927872259",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b5ef32a7-98b7-409e-b208-9363c54ec295",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3a1af430-70f4-44a8-a552-beb5f0a4b7bd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6583f845-3340-4520-8620-1b53154ad9e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1566265-cea0-4a3b-837d-9900eef77658",
"db_currency_id": "ad755bb8-17c1-49cd-a6b6-0c196ec56122",
"db_language_id": "68863a9b-e3dd-42c4-bcd1-dde2cf1eb40e",
"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-05-30T14:57:25.1664425+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T14:57:25.1664425+00:00"
},
"job_status_id": "c2dd2e30-1512-4701-9e27-d98652d58781",
"job_status_code": "sample string 11",
"db_address_id": "19fad9ad-ec1c-4e4d-b3a6-87fac6fab645",
"contact_id": "52bba909-ca1b-4f3c-a213-b8dddf28d8e1",
"requested_by_company_id": "0da14bdb-145e-4a12-ac7f-3a532a521bf8",
"requested_by_contact_id": "3629d009-8138-4463-ab0c-5c33566249ab",
"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-05-30T14:57:25.1664425+00:00",
"due_date": "2026-05-30T14:57:25.1664425+00:00",
"date_create": "2026-05-30T14:57:25.1664425+00:00",
"date_update": "2026-05-30T14:57:25.1664425+00:00",
"date_closed": "2026-05-30T14:57:25.1664425+00:00",
"suggested_user_id": "32068250-27db-41ff-b4f6-e2dd762af2f0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "86b3fa39-af0a-425c-9ec5-23f1c39e84be",
"db_language_id": "4d40aed7-b5c9-46dc-a95f-5b77a202ebd9",
"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-05-30T14:57:25.1664425+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4f939f1a-f12d-4c16-bd31-15cf2ccc98e9",
"sales_organization": {
"id": "6583f845-3340-4520-8620-1b53154ad9e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1566265-cea0-4a3b-837d-9900eef77658",
"db_currency_id": "ad755bb8-17c1-49cd-a6b6-0c196ec56122",
"db_language_id": "68863a9b-e3dd-42c4-bcd1-dde2cf1eb40e",
"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-05-30T14:57:25.1664425+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b8639ea8-a81c-4416-b8fc-56ff7bb3c2b9",
"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": "3e34bde5-9078-44aa-8774-bade65d4a881",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-30T14:57:25.1664425+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3c0ac155-084a-46f2-838f-886a7d8c399f"
},
"suggested_date_start": "2026-05-30T14:57:25.1664425+00:00",
"skill_id": "a2925e43-02b1-4afd-9663-9a23e6c9b1de",
"skill_code": "sample string 32",
"skill": {
"id": "3195551b-aca3-4441-b227-b6accb6498ed",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "56f02d5f-c41d-4345-9e5e-f1bb0a619b19",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6583f845-3340-4520-8620-1b53154ad9e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1566265-cea0-4a3b-837d-9900eef77658",
"db_currency_id": "ad755bb8-17c1-49cd-a6b6-0c196ec56122",
"db_language_id": "68863a9b-e3dd-42c4-bcd1-dde2cf1eb40e",
"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-05-30T14:57:25.1664425+00:00"
},
"modified_dateutc": "2026-05-30T14:57:25.1664425+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bc1364d4-cc2d-4a86-b208-0c863d2111cb",
"date_reported_by_company": "2026-05-30T14:57:25.1664425+00:00",
"id2": 36,
"company_id": "7df42b1f-3929-4821-be9d-6b6fe3aed23f",
"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": "d6e40c6b-7bad-40ad-9dbd-6277bdd64274",
"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-05-30T14:57:25.1664425+00:00"
},
"work_instruction_details_id": "d6b50885-6167-4eac-858c-83f2fa1d13cf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "455ef487-9b8c-4eb7-9820-0a6dca69ccae",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9f0fdb22-dfb2-4c98-8aef-33a501b9ed1f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-30T14:57:25.1664425+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": "b5f35aaf-dcd5-4e3d-bdb7-00b9688821e7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-30T14:57:25.1664425+00:00"
}