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": "fa9cafff-a1ca-4d1d-a1be-fd05bb402e51",
"jobs_id": "b446af65-1960-4849-8d47-20e8bea40ab0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0ca97776-427f-44ff-935f-9ae49dd4a2f1",
"_parent_id": "8b91e93c-79f7-48ac-bb9f-708602aa3aae",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "149cdc25-2117-41b3-81f9-bb0993469174",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8cbf0866-8504-4e9f-b6e1-4f45131b473f",
"_parent_id": "6797e21d-bc7e-4551-925e-162ddb7bcb8e",
"root_parent_id": "004e6bf6-298b-4625-98a6-993133887b3e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "85a26e8c-5219-4efe-8bcb-da0871b6e052",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fb110f17-9d58-4a1d-b64e-e8ec183bd1db",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fe73ce48-3895-479e-ac6d-a389dc7a795b",
"_parent_code": "sample string 6",
"sales_organization_id": "eaa212ea-96b2-450a-a2a1-6e4cebdab17f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5dad519f-7453-40db-847b-82971f767b23",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa9496e7-9202-40ae-8bba-3af4f8bd4ac9",
"db_currency_id": "b3bc3a9b-60ad-40aa-8ab8-27c85f48abe0",
"db_language_id": "7d05925b-8a0c-445f-84d0-5c201fc0017c",
"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-07-18T10:27:54.7624634+00:00"
},
"modified_dateutc": "2026-07-18T10:27:54.7624634+00:00"
},
"equipment_model_id": "1f46b1bd-ce62-4f61-8618-5d542af230c2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8886be9d-0573-47cb-8b74-bca6fd5d9a99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2c7da035-a1af-41a0-93bb-929fea08d61d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2cad5e89-d97f-4c71-b4d6-138137c24bcf",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2ffd96d8-c230-4fa7-b4c3-b8a9e24b0645",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5dad519f-7453-40db-847b-82971f767b23",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa9496e7-9202-40ae-8bba-3af4f8bd4ac9",
"db_currency_id": "b3bc3a9b-60ad-40aa-8ab8-27c85f48abe0",
"db_language_id": "7d05925b-8a0c-445f-84d0-5c201fc0017c",
"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-07-18T10:27:54.7624634+00:00"
},
"modified_dateutc": "2026-07-18T10:27:54.7624634+00:00"
},
"equipment_family_id": "e28a2008-276f-41e7-b450-529bcfa72ecb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fb110f17-9d58-4a1d-b64e-e8ec183bd1db",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fe73ce48-3895-479e-ac6d-a389dc7a795b",
"_parent_code": "sample string 6",
"sales_organization_id": "eaa212ea-96b2-450a-a2a1-6e4cebdab17f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5dad519f-7453-40db-847b-82971f767b23",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa9496e7-9202-40ae-8bba-3af4f8bd4ac9",
"db_currency_id": "b3bc3a9b-60ad-40aa-8ab8-27c85f48abe0",
"db_language_id": "7d05925b-8a0c-445f-84d0-5c201fc0017c",
"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-07-18T10:27:54.7624634+00:00"
},
"modified_dateutc": "2026-07-18T10:27:54.7624634+00:00"
},
"date_in_production_since": "2026-07-18T10:27:54.7624634+00:00",
"date_out_of_production_since": "2026-07-18T10:27:54.7624634+00:00",
"date_end_support": "2026-07-18T10:27:54.7624634+00:00",
"sales_organization_id": "c241d1ea-c1a3-49da-84f2-2dd343315962",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5dad519f-7453-40db-847b-82971f767b23",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa9496e7-9202-40ae-8bba-3af4f8bd4ac9",
"db_currency_id": "b3bc3a9b-60ad-40aa-8ab8-27c85f48abe0",
"db_language_id": "7d05925b-8a0c-445f-84d0-5c201fc0017c",
"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-07-18T10:27:54.7624634+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-07-18T10:27:54.7624634+00:00"
},
"project_status_id": "81f822dc-a2e7-4ac0-a096-d05f623f0608",
"project_status_code": "sample string 10",
"project_status": {
"id": "1cc8ac2e-352c-4f88-bdd4-475e3374bc12",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "709a62ae-1855-403b-af2a-071c4b7945bb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5dad519f-7453-40db-847b-82971f767b23",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa9496e7-9202-40ae-8bba-3af4f8bd4ac9",
"db_currency_id": "b3bc3a9b-60ad-40aa-8ab8-27c85f48abe0",
"db_language_id": "7d05925b-8a0c-445f-84d0-5c201fc0017c",
"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-07-18T10:27:54.7624634+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-18T10:27:54.7624634+00:00"
},
"company_id": "1ee9cc97-3e08-4bc2-b32c-c9a3b34957a4",
"company_code": "sample string 12",
"db_address_id": "d93794db-a055-494c-9c5f-9c0973aa7fc8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2766febc-cd89-4584-923c-30da38b95834",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c08e73d0-48ec-443e-b830-89f6f23332e6",
"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-07-18T10:27:54.7624634+00:00",
"date_create": "2026-07-18T10:27:54.7624634+00:00",
"date_update": "2026-07-18T10:27:54.7624634+00:00",
"updated_by_user_id": "84c2b79e-fb23-4787-8cf3-11a980eb52e1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-18T10:27:54.7624634+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-07-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-18T10:27:54.7624634+00:00",
"date_last_job": "2026-07-18T10:27:54.7624634+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-18T10:27:54.7624634+00:00",
"modified_dateutc": "2026-07-18T10:27:54.7624634+00:00",
"is_mobile_installation": true
},
"job_type_id": "10222d18-f5d5-4e77-b492-a4a974e000c8",
"job_type_code": "sample string 7",
"job_type": {
"id": "a0723d87-7ab1-4f29-a7d5-9c9c132b4173",
"name": "sample string 2",
"sales_organization_id": "59efe585-14a2-43c2-96eb-e5ffa4df5c86",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-18T10:27:54.7624634+00:00",
"code": "sample string 7"
},
"job_priority_id": "879d052f-69a4-4d28-bdf7-6af809885406",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "dacef0ff-3ecd-47d3-9e2b-28bf417529e0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fd1fe43a-6a7b-4b77-84d8-0be67500f554",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5dad519f-7453-40db-847b-82971f767b23",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa9496e7-9202-40ae-8bba-3af4f8bd4ac9",
"db_currency_id": "b3bc3a9b-60ad-40aa-8ab8-27c85f48abe0",
"db_language_id": "7d05925b-8a0c-445f-84d0-5c201fc0017c",
"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-07-18T10:27:54.7624634+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-18T10:27:54.7624634+00:00"
},
"job_status_id": "e85818ab-e167-4e2e-b722-c6f246ba1f08",
"job_status_code": "sample string 11",
"db_address_id": "5c5f62d5-36ec-4e7b-b68e-ada98d41abd6",
"contact_id": "42edfd76-b7e1-4a4e-be91-12537c19f303",
"requested_by_company_id": "66fe5d86-b97f-48d8-8106-67e0dcf9cc7a",
"requested_by_contact_id": "e5a4acbf-dac9-4ef9-bc78-5fb138e48a76",
"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-07-18T10:27:54.7624634+00:00",
"due_date": "2026-07-18T10:27:54.7624634+00:00",
"date_create": "2026-07-18T10:27:54.7624634+00:00",
"date_update": "2026-07-18T10:27:54.7624634+00:00",
"date_closed": "2026-07-18T10:27:54.7624634+00:00",
"suggested_user_id": "c74c3c62-1dc7-48d8-beb8-d5ba5559ba96",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "39fc096f-5aeb-49b2-aacc-66c0914615c8",
"db_language_id": "317a0e81-eba5-4314-8901-86a06e8772b9",
"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-07-18T10:27:54.7624634+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "92a31a41-5e92-480a-93b2-a987b73430fe",
"sales_organization": {
"id": "5dad519f-7453-40db-847b-82971f767b23",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa9496e7-9202-40ae-8bba-3af4f8bd4ac9",
"db_currency_id": "b3bc3a9b-60ad-40aa-8ab8-27c85f48abe0",
"db_language_id": "7d05925b-8a0c-445f-84d0-5c201fc0017c",
"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-07-18T10:27:54.7624634+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "36d00a4b-7e49-4364-b157-e09c54f18ec9",
"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": "60f44ae4-5c7d-4d05-9c5a-430077fd6c69",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-18T10:27:54.7624634+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "684e1f18-3da7-458a-8680-e1e04cd3aa64"
},
"suggested_date_start": "2026-07-18T10:27:54.7624634+00:00",
"skill_id": "f00352d1-984e-4a7f-88f2-60f353e29d8a",
"skill_code": "sample string 32",
"skill": {
"id": "f58685cb-7480-48fc-9e28-04f85c963f9b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "73e137fb-e9aa-43d2-a07d-6817cbb94c24",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5dad519f-7453-40db-847b-82971f767b23",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa9496e7-9202-40ae-8bba-3af4f8bd4ac9",
"db_currency_id": "b3bc3a9b-60ad-40aa-8ab8-27c85f48abe0",
"db_language_id": "7d05925b-8a0c-445f-84d0-5c201fc0017c",
"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-07-18T10:27:54.7624634+00:00"
},
"modified_dateutc": "2026-07-18T10:27:54.7624634+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "db489cca-4a0a-4987-8d2a-136eca7e92ff",
"date_reported_by_company": "2026-07-18T10:27:54.7624634+00:00",
"id2": 36,
"company_id": "f4e5335d-98ce-4717-a908-4e47952fd812",
"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": "330ecbed-a296-4750-9b1b-3b50e1139526",
"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-07-18T10:27:54.7624634+00:00"
},
"work_instruction_details_id": "80291db1-0985-4eea-9897-34bc51af2e42",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8b259f5d-2a1f-4cef-82d7-5a4b18e13449",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "502920f7-00ae-4240-8803-edad7f539041",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-18T10:27:54.7624634+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": "4dba6a01-1de8-4e55-8a07-18eff724923a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-18T10:27:54.7624634+00:00"
}