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": "12578673-ebf9-4ddb-97e8-c776d846278a",
"jobs_id": "5cd1dc78-951c-40db-b2f8-5ae6f6f7e197",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8a03ca79-d866-4f61-99d5-9508b719931e",
"_parent_id": "0fe5959c-3d08-4689-9cc1-12d727224e0a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "12f936de-148a-416e-8201-dc2b0964d03b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d1a8822d-4411-4b90-ade5-16852df00f96",
"_parent_id": "44bccba3-14b9-4b42-baa9-6e1d1ed316cb",
"root_parent_id": "eafc06dc-baba-4a91-a811-7ae4b0ec283e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a173f9ce-60c4-45d8-8e14-02ab9ded63c2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9831db11-f896-4e87-8d13-4bb764441e33",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7b99cc7f-f9e4-49dd-96eb-bd46c5d47b8f",
"_parent_code": "sample string 6",
"sales_organization_id": "841f239d-4686-429f-ac4f-08a22099b62c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7f865521-db01-4147-be10-7c63c202d3f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b9339d6b-0d73-4040-bfaa-6c185ec2eed4",
"db_currency_id": "6e5b3f74-feca-4ac9-a834-b25d7648f1f0",
"db_language_id": "7dc16e56-2ee6-4ddb-ac05-f517a59031a0",
"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": "2025-12-25T10:55:52.8646682+00:00"
},
"modified_dateutc": "2025-12-25T10:55:52.8646682+00:00"
},
"equipment_model_id": "8899dd1a-5235-46bb-88a5-c747ca00ae11",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "721c3f27-0456-4b75-aff7-cf6707cb5ac1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e1d9bdd3-3cb7-470e-b102-5f953b813b39",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d327c93d-36fc-4029-b37e-38d972264254",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a10b7129-3965-4f91-b2d2-8b51d6331f2c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7f865521-db01-4147-be10-7c63c202d3f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b9339d6b-0d73-4040-bfaa-6c185ec2eed4",
"db_currency_id": "6e5b3f74-feca-4ac9-a834-b25d7648f1f0",
"db_language_id": "7dc16e56-2ee6-4ddb-ac05-f517a59031a0",
"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": "2025-12-25T10:55:52.8646682+00:00"
},
"modified_dateutc": "2025-12-25T10:55:52.8646682+00:00"
},
"equipment_family_id": "0cf5cd7d-9935-4103-89a3-9dd1c65bdab6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9831db11-f896-4e87-8d13-4bb764441e33",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7b99cc7f-f9e4-49dd-96eb-bd46c5d47b8f",
"_parent_code": "sample string 6",
"sales_organization_id": "841f239d-4686-429f-ac4f-08a22099b62c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7f865521-db01-4147-be10-7c63c202d3f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b9339d6b-0d73-4040-bfaa-6c185ec2eed4",
"db_currency_id": "6e5b3f74-feca-4ac9-a834-b25d7648f1f0",
"db_language_id": "7dc16e56-2ee6-4ddb-ac05-f517a59031a0",
"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": "2025-12-25T10:55:52.8646682+00:00"
},
"modified_dateutc": "2025-12-25T10:55:52.8646682+00:00"
},
"date_in_production_since": "2025-12-25T10:55:52.8646682+00:00",
"date_out_of_production_since": "2025-12-25T10:55:52.8646682+00:00",
"date_end_support": "2025-12-25T10:55:52.8646682+00:00",
"sales_organization_id": "43a10d0c-f3d3-4267-84c9-cfd15b856746",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7f865521-db01-4147-be10-7c63c202d3f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b9339d6b-0d73-4040-bfaa-6c185ec2eed4",
"db_currency_id": "6e5b3f74-feca-4ac9-a834-b25d7648f1f0",
"db_language_id": "7dc16e56-2ee6-4ddb-ac05-f517a59031a0",
"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": "2025-12-25T10:55:52.8646682+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": "2025-12-25T10:55:52.8646682+00:00"
},
"project_status_id": "d488ab41-ed54-42f0-a55e-eb0132957390",
"project_status_code": "sample string 10",
"project_status": {
"id": "cb8b3d62-1467-461d-bca9-eeb5339cf2f4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0e3b5e8f-a814-4f5d-8e95-6359956b4939",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7f865521-db01-4147-be10-7c63c202d3f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b9339d6b-0d73-4040-bfaa-6c185ec2eed4",
"db_currency_id": "6e5b3f74-feca-4ac9-a834-b25d7648f1f0",
"db_language_id": "7dc16e56-2ee6-4ddb-ac05-f517a59031a0",
"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": "2025-12-25T10:55:52.8646682+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-25T10:55:52.8646682+00:00"
},
"company_id": "b46e1738-5b53-405a-9481-d3568cc92e2a",
"company_code": "sample string 12",
"db_address_id": "1251c7b8-242a-457d-8770-9b975e359e1d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1c3ba2cc-abed-4ac2-b778-acf1e49858cf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "58153ee5-e98d-4d63-9622-61a19a7353ec",
"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": "2025-12-25T10:55:52.8646682+00:00",
"date_create": "2025-12-25T10:55:52.8646682+00:00",
"date_update": "2025-12-25T10:55:52.8646682+00:00",
"updated_by_user_id": "804759f1-d7b1-4c67-a119-82322ea5eb7f",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-25T10:55:52.8646682+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": "2025-12-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-25T10:55:52.8646682+00:00",
"date_last_job": "2025-12-25T10:55:52.8646682+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-25T10:55:52.8646682+00:00",
"modified_dateutc": "2025-12-25T10:55:52.8646682+00:00",
"is_mobile_installation": true
},
"job_type_id": "e10220c5-3b7e-44da-bc94-815be4b90ff5",
"job_type_code": "sample string 7",
"job_type": {
"id": "8389f6d8-e36a-49af-a06a-547568182201",
"name": "sample string 2",
"sales_organization_id": "ca126399-62b3-42f6-83a3-16ab61dd8e9b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-25T10:55:52.8646682+00:00",
"code": "sample string 7"
},
"job_priority_id": "f21ce2f3-256b-42f8-93d6-4fb1d801d7bf",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "68a3d6c6-26e1-4d78-b461-b03b02627391",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2450e5bc-d360-4d54-aa96-c5687d337790",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7f865521-db01-4147-be10-7c63c202d3f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b9339d6b-0d73-4040-bfaa-6c185ec2eed4",
"db_currency_id": "6e5b3f74-feca-4ac9-a834-b25d7648f1f0",
"db_language_id": "7dc16e56-2ee6-4ddb-ac05-f517a59031a0",
"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": "2025-12-25T10:55:52.8646682+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-25T10:55:52.8646682+00:00"
},
"job_status_id": "068f6809-571d-4e84-bbd0-0a25a853adb8",
"job_status_code": "sample string 11",
"db_address_id": "b856d504-5b6e-4882-9a26-ddade75a2127",
"contact_id": "7e4a41d3-729a-4810-ad25-116bb2d655f5",
"requested_by_company_id": "2ab4d174-5e4d-48a3-a981-3a39a6a6875e",
"requested_by_contact_id": "74092d14-9414-402c-8093-324d3afeb273",
"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": "2025-12-25T10:55:52.8646682+00:00",
"due_date": "2025-12-25T10:55:52.8646682+00:00",
"date_create": "2025-12-25T10:55:52.8646682+00:00",
"date_update": "2025-12-25T10:55:52.8646682+00:00",
"date_closed": "2025-12-25T10:55:52.8646682+00:00",
"suggested_user_id": "45fc6b52-ea41-42f6-b1f2-873d8be984a9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "605b005c-9dfb-47a5-b423-db760ea42a07",
"db_language_id": "74637369-6d81-48b4-a7ea-edb737b34e73",
"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": "2025-12-25T10:55:52.8646682+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "517fa873-fd38-45ec-b80c-e8b43ea17bf7",
"sales_organization": {
"id": "7f865521-db01-4147-be10-7c63c202d3f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b9339d6b-0d73-4040-bfaa-6c185ec2eed4",
"db_currency_id": "6e5b3f74-feca-4ac9-a834-b25d7648f1f0",
"db_language_id": "7dc16e56-2ee6-4ddb-ac05-f517a59031a0",
"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": "2025-12-25T10:55:52.8646682+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "76bed887-ad5b-45b1-8a75-fd60d932d899",
"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": "41810348-fde1-4858-92ff-7098d91383e5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-25T10:55:52.8646682+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "282e1d59-282c-4efb-922a-4d4e21fe57d2"
},
"suggested_date_start": "2025-12-25T10:55:52.8646682+00:00",
"skill_id": "40a11d5c-77b0-425a-b9a1-7153f860f21a",
"skill_code": "sample string 32",
"skill": {
"id": "eae4bb4c-3479-47bf-94ac-ed596786087b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bb95cc3a-8c8d-4135-87ec-5d73c6ae3ed7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7f865521-db01-4147-be10-7c63c202d3f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b9339d6b-0d73-4040-bfaa-6c185ec2eed4",
"db_currency_id": "6e5b3f74-feca-4ac9-a834-b25d7648f1f0",
"db_language_id": "7dc16e56-2ee6-4ddb-ac05-f517a59031a0",
"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": "2025-12-25T10:55:52.8646682+00:00"
},
"modified_dateutc": "2025-12-25T10:55:52.8646682+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9563e507-20e7-4d43-bdb9-bcee23faa2f6",
"date_reported_by_company": "2025-12-25T10:55:52.8646682+00:00",
"id2": 36,
"company_id": "19d149a4-c5da-449f-950e-9f738c43ed1f",
"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": "e26af754-a651-4242-86fd-14d9f87e9736",
"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": "2025-12-25T10:55:52.8646682+00:00"
},
"work_instruction_details_id": "3044580c-7079-432b-b4f3-4e28f7302a92",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a4837309-ea64-4392-80f6-a4790dc4816f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "eb23d134-0ee6-4708-94f4-05e6ffc31176",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-25T10:55:52.8646682+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": "7b2f9811-bb08-48e6-ad34-1a3e9217b08a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-25T10:55:52.8646682+00:00"
}