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": "8d424613-f54e-4de8-9df7-eaf715f63a21",
"jobs_id": "4a9288b0-aba7-4468-b2f9-491a53042c6e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "eb6bc44d-af5a-4304-939d-8d1d79efa7dd",
"_parent_id": "558af3d7-8ae2-45ec-bb5c-4d7e63521036",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2faaee2f-0c67-422e-b734-8e0d88e23f49",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6db06097-a414-4c30-aafc-25891d847ff0",
"_parent_id": "1e98345b-8e13-475f-b318-6e640b0468d5",
"root_parent_id": "16988849-ea80-4dbd-9a73-a1b0fdf5a86d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2b19f2bd-bc65-45d2-a3df-a2ecbb41be3c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9184839a-ef2a-4ec8-bec8-a34acd621957",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bd69acfe-ce4d-4c4d-a02d-bd1e8dbea940",
"_parent_code": "sample string 6",
"sales_organization_id": "f7959a54-d8ad-498c-9431-b4f70a8e46a4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "72a2af1f-f1b7-4029-a90f-df3be1e52b64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f690b37-32eb-4193-bdf6-b21b1e435dfc",
"db_currency_id": "8e18ee11-6330-4ce9-8834-2d24020a7d1c",
"db_language_id": "3fbfce56-548e-40e9-93b0-6aa61c192976",
"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-09-22T20:35:55.8163341+00:00"
},
"modified_dateutc": "2026-09-22T20:35:55.8163341+00:00"
},
"equipment_model_id": "12dda6a5-51dd-46e3-ad72-39457ff1b477",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9ec97c38-a759-42ee-98bb-f022bac95838",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6ae7e525-f680-45e0-9ab9-d7d7698f695c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "295118d2-2736-4fe5-9b16-40a9b9e37652",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0b4c3885-3234-4e81-a582-f5822c432744",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "72a2af1f-f1b7-4029-a90f-df3be1e52b64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f690b37-32eb-4193-bdf6-b21b1e435dfc",
"db_currency_id": "8e18ee11-6330-4ce9-8834-2d24020a7d1c",
"db_language_id": "3fbfce56-548e-40e9-93b0-6aa61c192976",
"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-09-22T20:35:55.8163341+00:00"
},
"modified_dateutc": "2026-09-22T20:35:55.8163341+00:00"
},
"equipment_family_id": "8b8ca44d-c887-4f38-afbd-b2e3af6b62c6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9184839a-ef2a-4ec8-bec8-a34acd621957",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bd69acfe-ce4d-4c4d-a02d-bd1e8dbea940",
"_parent_code": "sample string 6",
"sales_organization_id": "f7959a54-d8ad-498c-9431-b4f70a8e46a4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "72a2af1f-f1b7-4029-a90f-df3be1e52b64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f690b37-32eb-4193-bdf6-b21b1e435dfc",
"db_currency_id": "8e18ee11-6330-4ce9-8834-2d24020a7d1c",
"db_language_id": "3fbfce56-548e-40e9-93b0-6aa61c192976",
"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-09-22T20:35:55.8163341+00:00"
},
"modified_dateutc": "2026-09-22T20:35:55.8163341+00:00"
},
"date_in_production_since": "2026-09-22T20:35:55.8163341+00:00",
"date_out_of_production_since": "2026-09-22T20:35:55.8163341+00:00",
"date_end_support": "2026-09-22T20:35:55.8163341+00:00",
"sales_organization_id": "2581ed77-5338-472a-a359-a76fe1c79523",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "72a2af1f-f1b7-4029-a90f-df3be1e52b64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f690b37-32eb-4193-bdf6-b21b1e435dfc",
"db_currency_id": "8e18ee11-6330-4ce9-8834-2d24020a7d1c",
"db_language_id": "3fbfce56-548e-40e9-93b0-6aa61c192976",
"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-09-22T20:35:55.8163341+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-09-22T20:35:55.8163341+00:00"
},
"project_status_id": "ae1f676f-1284-4946-9fc5-329667f53906",
"project_status_code": "sample string 10",
"project_status": {
"id": "3112eeab-ba52-42e5-a9ff-2e71816e3855",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ff1ba077-8cb9-49f6-af01-a0b3a4d9b3a1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "72a2af1f-f1b7-4029-a90f-df3be1e52b64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f690b37-32eb-4193-bdf6-b21b1e435dfc",
"db_currency_id": "8e18ee11-6330-4ce9-8834-2d24020a7d1c",
"db_language_id": "3fbfce56-548e-40e9-93b0-6aa61c192976",
"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-09-22T20:35:55.8163341+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-22T20:35:55.8163341+00:00"
},
"company_id": "42ca32a8-ff36-4fdc-b850-59f79393eeff",
"company_code": "sample string 12",
"db_address_id": "fce3a539-7f77-4072-b185-ed7023550f5c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "edc756eb-4fc6-4986-98d3-ef04908b75c1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a370196f-b82d-4fee-bc29-e830cdc533d5",
"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-09-22T20:35:55.8163341+00:00",
"date_create": "2026-09-22T20:35:55.8163341+00:00",
"date_update": "2026-09-22T20:35:55.8163341+00:00",
"updated_by_user_id": "79b10830-8b22-46bc-ae3d-381988e2ca8a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-22T20:35:55.8163341+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-09-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-22T20:35:55.8163341+00:00",
"date_last_job": "2026-09-22T20:35:55.8163341+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-22T20:35:55.8163341+00:00",
"modified_dateutc": "2026-09-22T20:35:55.8163341+00:00",
"is_mobile_installation": true
},
"job_type_id": "92d4af3f-28b3-4256-9167-fad3a367b539",
"job_type_code": "sample string 7",
"job_type": {
"id": "bef80713-aef3-467c-ad0b-575d571dc83e",
"name": "sample string 2",
"sales_organization_id": "9a56969e-6075-4ded-9e92-87db69557a64",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-22T20:35:55.8163341+00:00",
"code": "sample string 7"
},
"job_priority_id": "08b4ce76-a9c8-46ff-b36e-067c5d31e712",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5f6e0263-05b9-46b7-9fa8-46fc3fd5577a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "93b3d202-c911-4575-bbd2-bc45e727003b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "72a2af1f-f1b7-4029-a90f-df3be1e52b64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f690b37-32eb-4193-bdf6-b21b1e435dfc",
"db_currency_id": "8e18ee11-6330-4ce9-8834-2d24020a7d1c",
"db_language_id": "3fbfce56-548e-40e9-93b0-6aa61c192976",
"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-09-22T20:35:55.8163341+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-22T20:35:55.8163341+00:00"
},
"job_status_id": "cf2e9c0d-2482-473a-9767-e6361a2515d4",
"job_status_code": "sample string 11",
"db_address_id": "fbfc36f0-3b14-428a-b5cc-80a7c6f5be7d",
"contact_id": "73e3e9cf-8989-4618-89be-51ca0f0bf545",
"requested_by_company_id": "283f181c-f8a8-485b-ba06-20c2cbc90b00",
"requested_by_contact_id": "19679760-2f46-4a1f-8549-d9832bad29df",
"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-09-22T20:35:55.8163341+00:00",
"due_date": "2026-09-22T20:35:55.8163341+00:00",
"date_create": "2026-09-22T20:35:55.8163341+00:00",
"date_update": "2026-09-22T20:35:55.8163341+00:00",
"date_closed": "2026-09-22T20:35:55.8163341+00:00",
"suggested_user_id": "8f38f807-7b0d-4ac5-acdd-84039544f149",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "73367866-ded0-43df-9c63-20617d19ca25",
"db_language_id": "05e1fd5d-2df5-4281-a511-9c17bd138f84",
"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-09-22T20:35:55.8163341+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "53ceae61-f685-4263-ac88-ff57d781db23",
"sales_organization": {
"id": "72a2af1f-f1b7-4029-a90f-df3be1e52b64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f690b37-32eb-4193-bdf6-b21b1e435dfc",
"db_currency_id": "8e18ee11-6330-4ce9-8834-2d24020a7d1c",
"db_language_id": "3fbfce56-548e-40e9-93b0-6aa61c192976",
"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-09-22T20:35:55.8163341+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b230a6e3-9650-4fd1-aae9-9e5ab61b93a1",
"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": "d4e568df-a621-437c-9dcd-fe63a8c3d109",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-22T20:35:55.8163341+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f4bd8ba6-f082-491c-abc2-db040610acf4"
},
"suggested_date_start": "2026-09-22T20:35:55.8163341+00:00",
"skill_id": "3d1ea3f5-4b1d-4b1d-a184-6a91f5b85018",
"skill_code": "sample string 32",
"skill": {
"id": "49d8fa86-c70e-45af-95da-62d75f6c6d72",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d8b52666-2b09-4baa-9f7e-39485f9296af",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "72a2af1f-f1b7-4029-a90f-df3be1e52b64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f690b37-32eb-4193-bdf6-b21b1e435dfc",
"db_currency_id": "8e18ee11-6330-4ce9-8834-2d24020a7d1c",
"db_language_id": "3fbfce56-548e-40e9-93b0-6aa61c192976",
"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-09-22T20:35:55.8163341+00:00"
},
"modified_dateutc": "2026-09-22T20:35:55.8163341+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "13937dbb-2082-41d2-8a7e-9338aed0ba1a",
"date_reported_by_company": "2026-09-22T20:35:55.8163341+00:00",
"id2": 36,
"company_id": "6a9a6715-7dd8-493c-8932-f36118b9ff50",
"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": "ea12ec7a-8523-457d-8aec-e4d40001dec8",
"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-09-22T20:35:55.8163341+00:00"
},
"work_instruction_details_id": "1fdb34f6-210b-4464-b15b-24083ce7a78d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "62f65807-0a87-43f7-9fa5-e76a0cd801af",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "59fdbe99-4413-4fc0-9178-94abeefbaf4b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-22T20:35:55.8163341+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": "b90737e5-bba3-4aad-95cd-4b852c756961",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-22T20:35:55.8163341+00:00"
}