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": "fc1e493e-9df6-469f-b1d3-cdf05cee6e63",
"jobs_id": "90c88535-388d-45e4-baaf-998470edda13",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8b16b8cf-c725-4ab6-b015-ab46bb5ce881",
"_parent_id": "9c661539-b6fd-4e93-8e66-1ea07079ae81",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "79a1f10c-2995-4d33-9d9e-0d9baa491843",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8c27a844-43e6-4c0b-ab15-43a553630b03",
"_parent_id": "f54da956-ec92-4f3c-89ee-9952e95b462f",
"root_parent_id": "669b86f0-f30c-4789-be43-201aae5cc3b0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bf82186c-3c96-42c6-bc28-45d2968fca07",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a0184bf6-4a7b-470b-bb88-28400e6accc2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "924c013d-3aa3-46a5-8c77-a0472cc03443",
"_parent_code": "sample string 6",
"sales_organization_id": "61b6648d-3919-4d6d-af64-bca5c1babff4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "07c71f3b-502c-4eb3-8c1e-404a756a1986",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "862467c6-bf4d-4752-802e-8b8fd3c5cd52",
"db_currency_id": "5b5f99f9-4e12-40ef-83ae-f94277c964b4",
"db_language_id": "f125c051-b268-42a5-9eef-51b08626fdaa",
"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-15T11:35:37.5873318+00:00"
},
"modified_dateutc": "2026-05-15T11:35:37.5873318+00:00"
},
"equipment_model_id": "8403d8f3-2e59-4841-825c-0cb72821b2a6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "caf329bb-6f1f-48b8-8804-c76a6d5dee48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7653d476-0ccd-4b40-adf6-5c39bdd0aa1f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dca033a6-2c6a-4205-b4e2-f309322da394",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4156cac5-0cc6-45b0-9242-374773c8d423",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "07c71f3b-502c-4eb3-8c1e-404a756a1986",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "862467c6-bf4d-4752-802e-8b8fd3c5cd52",
"db_currency_id": "5b5f99f9-4e12-40ef-83ae-f94277c964b4",
"db_language_id": "f125c051-b268-42a5-9eef-51b08626fdaa",
"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-15T11:35:37.5873318+00:00"
},
"modified_dateutc": "2026-05-15T11:35:37.5873318+00:00"
},
"equipment_family_id": "a75cb7de-f729-44dc-999b-d7536701763f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a0184bf6-4a7b-470b-bb88-28400e6accc2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "924c013d-3aa3-46a5-8c77-a0472cc03443",
"_parent_code": "sample string 6",
"sales_organization_id": "61b6648d-3919-4d6d-af64-bca5c1babff4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "07c71f3b-502c-4eb3-8c1e-404a756a1986",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "862467c6-bf4d-4752-802e-8b8fd3c5cd52",
"db_currency_id": "5b5f99f9-4e12-40ef-83ae-f94277c964b4",
"db_language_id": "f125c051-b268-42a5-9eef-51b08626fdaa",
"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-15T11:35:37.5873318+00:00"
},
"modified_dateutc": "2026-05-15T11:35:37.5873318+00:00"
},
"date_in_production_since": "2026-05-15T11:35:37.5873318+00:00",
"date_out_of_production_since": "2026-05-15T11:35:37.5873318+00:00",
"date_end_support": "2026-05-15T11:35:37.5873318+00:00",
"sales_organization_id": "e81890e5-b0e2-45ad-ad1c-2f9ca1134da0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "07c71f3b-502c-4eb3-8c1e-404a756a1986",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "862467c6-bf4d-4752-802e-8b8fd3c5cd52",
"db_currency_id": "5b5f99f9-4e12-40ef-83ae-f94277c964b4",
"db_language_id": "f125c051-b268-42a5-9eef-51b08626fdaa",
"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-15T11:35:37.5873318+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-15T11:35:37.5873318+00:00"
},
"project_status_id": "9390e5bf-2458-4882-804c-3241894ad400",
"project_status_code": "sample string 10",
"project_status": {
"id": "b7e62676-de86-4305-bb1b-4c51060d571d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f48934fb-4350-4792-a4aa-32b10f5898b3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "07c71f3b-502c-4eb3-8c1e-404a756a1986",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "862467c6-bf4d-4752-802e-8b8fd3c5cd52",
"db_currency_id": "5b5f99f9-4e12-40ef-83ae-f94277c964b4",
"db_language_id": "f125c051-b268-42a5-9eef-51b08626fdaa",
"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-15T11:35:37.5873318+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-15T11:35:37.5873318+00:00"
},
"company_id": "c9a8df7c-8624-4013-a4a1-bbfbd47d53db",
"company_code": "sample string 12",
"db_address_id": "77696b92-a1f5-41e7-9e20-e6f7eada2d47",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8b02403a-0ff5-4958-a977-bd95c4438d1f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "38ae0da7-3052-499b-8983-9c7a1c0b0139",
"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-15T11:35:37.5873318+00:00",
"date_create": "2026-05-15T11:35:37.5873318+00:00",
"date_update": "2026-05-15T11:35:37.5873318+00:00",
"updated_by_user_id": "052bd9e0-2283-4d52-b965-fb36c2184a0f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-15T11:35:37.5873318+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-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-15T11:35:37.5873318+00:00",
"date_last_job": "2026-05-15T11:35:37.5873318+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-15T11:35:37.5873318+00:00",
"modified_dateutc": "2026-05-15T11:35:37.5873318+00:00",
"is_mobile_installation": true
},
"job_type_id": "8bfee3dc-5d8d-40d3-9918-ab4ec906d7de",
"job_type_code": "sample string 7",
"job_type": {
"id": "6ff96f9a-7d67-4aed-abbe-159e02f239ba",
"name": "sample string 2",
"sales_organization_id": "109d729b-7d20-4955-a74b-d406ed61bce4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-15T11:35:37.5873318+00:00",
"code": "sample string 7"
},
"job_priority_id": "bc90c60a-c9ee-4c88-82dc-d1cd2b8362f8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fc7ff467-9811-4aae-8fbd-ed85be590f7e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "deba9855-ca4e-4e4d-8800-959f5c17aac2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "07c71f3b-502c-4eb3-8c1e-404a756a1986",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "862467c6-bf4d-4752-802e-8b8fd3c5cd52",
"db_currency_id": "5b5f99f9-4e12-40ef-83ae-f94277c964b4",
"db_language_id": "f125c051-b268-42a5-9eef-51b08626fdaa",
"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-15T11:35:37.5873318+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-15T11:35:37.5873318+00:00"
},
"job_status_id": "f99e2ffd-b125-4a5e-b83f-b307c1888b90",
"job_status_code": "sample string 11",
"db_address_id": "211b842e-cc17-4ac0-8650-21ef3749d8a2",
"contact_id": "0a978ec4-425c-4511-8d37-033a4a803b9e",
"requested_by_company_id": "2ce2f9df-7d8f-4c30-bae7-49918438a817",
"requested_by_contact_id": "6cfa12e7-9bb5-4adf-b359-19e0fa93107e",
"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-15T11:35:37.5873318+00:00",
"due_date": "2026-05-15T11:35:37.5873318+00:00",
"date_create": "2026-05-15T11:35:37.5873318+00:00",
"date_update": "2026-05-15T11:35:37.5873318+00:00",
"date_closed": "2026-05-15T11:35:37.5873318+00:00",
"suggested_user_id": "88301f75-4aa8-4c51-b9af-85cf65b95b09",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d0bbd6c9-159c-4e58-abaa-2ce9537a4ca3",
"db_language_id": "26c8c18d-7204-422b-ab09-a9514fdb06be",
"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-15T11:35:37.5873318+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1925a83e-7a46-4c1f-a28e-9b847c49f5c4",
"sales_organization": {
"id": "07c71f3b-502c-4eb3-8c1e-404a756a1986",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "862467c6-bf4d-4752-802e-8b8fd3c5cd52",
"db_currency_id": "5b5f99f9-4e12-40ef-83ae-f94277c964b4",
"db_language_id": "f125c051-b268-42a5-9eef-51b08626fdaa",
"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-15T11:35:37.5873318+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "69c3e127-16d9-43b7-a30f-6a90639dd5bb",
"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": "2436463c-1662-4017-a5ed-18d020bf489c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-15T11:35:37.5873318+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3f5ea60f-2d0d-4bd5-b166-6c0028e61f76"
},
"suggested_date_start": "2026-05-15T11:35:37.5873318+00:00",
"skill_id": "be779794-ff0f-4334-9a9f-8ba4cd5a3c2f",
"skill_code": "sample string 32",
"skill": {
"id": "a80e6031-b4ab-445a-b777-22218ba4580e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fe50345c-7030-41ca-9296-f50c5db74f63",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "07c71f3b-502c-4eb3-8c1e-404a756a1986",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "862467c6-bf4d-4752-802e-8b8fd3c5cd52",
"db_currency_id": "5b5f99f9-4e12-40ef-83ae-f94277c964b4",
"db_language_id": "f125c051-b268-42a5-9eef-51b08626fdaa",
"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-15T11:35:37.5873318+00:00"
},
"modified_dateutc": "2026-05-15T11:35:37.5873318+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d1fb887f-47ec-4d42-8bf0-ef855c268994",
"date_reported_by_company": "2026-05-15T11:35:37.5873318+00:00",
"id2": 36,
"company_id": "8b8b7fb1-7e62-420b-bc27-8ada7b0d2064",
"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": "816ea85b-7b8c-4542-9b37-9e666edd46ad",
"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-15T11:35:37.5873318+00:00"
},
"work_instruction_details_id": "1de499a5-2cf8-4bbc-bdac-c5432676295a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0a73d343-e832-4fe3-9178-912eb6aa1346",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "29e2388f-a695-4a1a-aaf0-e95d25df2058",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-15T11:35:37.5873318+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": "f3932df4-7441-4aa1-9663-6e26e4b7035f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-15T11:35:37.5873318+00:00"
}