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": "191015c7-b50d-4b17-8225-04dc1a665bbc",
"jobs_id": "dee4f90b-df6a-47af-8ec1-58e98cd30e01",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "956b5c72-7a71-4cbe-a3ec-d79625a67ce0",
"_parent_id": "2fdc268e-c50c-4190-b051-efb67d441cd3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e227b24b-2464-4450-abf9-8b36f3b2b22b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cfbb6f7d-434e-4ef1-9e41-4240cd680e51",
"_parent_id": "effceac2-1a3c-4c27-bc69-611ea4a7296a",
"root_parent_id": "405cdbb6-c485-4200-8281-b434d64e0b06",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "10dd8ca5-543a-421b-bf33-195eaf40b418",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "afc961cc-6610-4888-ab89-d3bc9e4722c0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d3b93e5e-90a5-40b1-b6e6-4fdd2a412996",
"_parent_code": "sample string 6",
"sales_organization_id": "96ae0fa6-df15-4515-9410-976811ed0dcb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0da1a0ad-dab9-4eaf-8f17-42ed9cb59d8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147f4dca-1a42-4fa0-8302-0e4b123f245f",
"db_currency_id": "281fe6e2-c58b-4f26-8ff7-ca66239791f9",
"db_language_id": "f5534b0e-358c-466f-8538-ea1b316d29c9",
"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-21T10:31:29.5040288+00:00"
},
"modified_dateutc": "2026-05-21T10:31:29.5040288+00:00"
},
"equipment_model_id": "628d9167-ecc5-474b-b1ef-3e50a49d7302",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ea4f0685-b5b4-462d-8e6b-acd546d03fba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ff1fa3c0-0cb9-4723-9ca0-1302d4cd1e3a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a84c78b3-05e3-4078-ba0e-99eb9bce5edc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cbfeb137-eadc-46c1-970b-1fa29095a352",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0da1a0ad-dab9-4eaf-8f17-42ed9cb59d8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147f4dca-1a42-4fa0-8302-0e4b123f245f",
"db_currency_id": "281fe6e2-c58b-4f26-8ff7-ca66239791f9",
"db_language_id": "f5534b0e-358c-466f-8538-ea1b316d29c9",
"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-21T10:31:29.5040288+00:00"
},
"modified_dateutc": "2026-05-21T10:31:29.5040288+00:00"
},
"equipment_family_id": "c26f8efb-33cd-42af-b524-169f133892b1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "afc961cc-6610-4888-ab89-d3bc9e4722c0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d3b93e5e-90a5-40b1-b6e6-4fdd2a412996",
"_parent_code": "sample string 6",
"sales_organization_id": "96ae0fa6-df15-4515-9410-976811ed0dcb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0da1a0ad-dab9-4eaf-8f17-42ed9cb59d8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147f4dca-1a42-4fa0-8302-0e4b123f245f",
"db_currency_id": "281fe6e2-c58b-4f26-8ff7-ca66239791f9",
"db_language_id": "f5534b0e-358c-466f-8538-ea1b316d29c9",
"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-21T10:31:29.5040288+00:00"
},
"modified_dateutc": "2026-05-21T10:31:29.5040288+00:00"
},
"date_in_production_since": "2026-05-21T10:31:29.5040288+00:00",
"date_out_of_production_since": "2026-05-21T10:31:29.5040288+00:00",
"date_end_support": "2026-05-21T10:31:29.5040288+00:00",
"sales_organization_id": "7e41346f-4b44-44de-b3ba-d4dabd323ab4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0da1a0ad-dab9-4eaf-8f17-42ed9cb59d8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147f4dca-1a42-4fa0-8302-0e4b123f245f",
"db_currency_id": "281fe6e2-c58b-4f26-8ff7-ca66239791f9",
"db_language_id": "f5534b0e-358c-466f-8538-ea1b316d29c9",
"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-21T10:31:29.5040288+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-21T10:31:29.5040288+00:00"
},
"project_status_id": "3218e2a1-f8d3-45d0-b939-e3a6002a5595",
"project_status_code": "sample string 10",
"project_status": {
"id": "f17fb1cd-e526-43ef-b43b-9f870913c7d2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e3c08a1c-c8bc-441b-a595-fd8f51c55293",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0da1a0ad-dab9-4eaf-8f17-42ed9cb59d8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147f4dca-1a42-4fa0-8302-0e4b123f245f",
"db_currency_id": "281fe6e2-c58b-4f26-8ff7-ca66239791f9",
"db_language_id": "f5534b0e-358c-466f-8538-ea1b316d29c9",
"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-21T10:31:29.5040288+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T10:31:29.5040288+00:00"
},
"company_id": "ef780642-429a-4a0a-a9b1-ea43331d4bb7",
"company_code": "sample string 12",
"db_address_id": "5db0f72c-2680-4f12-ad89-5a840eab17da",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6954fbb1-8bd7-4553-8d95-0b66c103c977",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "eb472eb0-354d-453f-b6a7-871a6beb0707",
"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-21T10:31:29.5040288+00:00",
"date_create": "2026-05-21T10:31:29.5040288+00:00",
"date_update": "2026-05-21T10:31:29.5040288+00:00",
"updated_by_user_id": "1c87a427-2b19-47f9-a154-648dff55e298",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-21T10:31:29.5040288+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-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-21T10:31:29.5040288+00:00",
"date_last_job": "2026-05-21T10:31:29.5040288+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-21T10:31:29.5040288+00:00",
"modified_dateutc": "2026-05-21T10:31:29.5040288+00:00",
"is_mobile_installation": true
},
"job_type_id": "43d31065-1a6c-4945-a6c2-0a56e9d3f175",
"job_type_code": "sample string 7",
"job_type": {
"id": "d23fdfa5-3c3c-406a-ac41-dd24f61c9040",
"name": "sample string 2",
"sales_organization_id": "3eb5f727-9f41-4b6f-a5ed-1461c2fb25e5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-21T10:31:29.5040288+00:00",
"code": "sample string 7"
},
"job_priority_id": "85b8c2f7-d521-4c63-bf86-e04e0763fbf3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b632a2d4-9682-42f3-a106-b5f2b6457d11",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fdcf881f-2376-44e6-b416-00f527a7c283",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0da1a0ad-dab9-4eaf-8f17-42ed9cb59d8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147f4dca-1a42-4fa0-8302-0e4b123f245f",
"db_currency_id": "281fe6e2-c58b-4f26-8ff7-ca66239791f9",
"db_language_id": "f5534b0e-358c-466f-8538-ea1b316d29c9",
"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-21T10:31:29.5040288+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T10:31:29.5040288+00:00"
},
"job_status_id": "da07ef95-ba7d-4223-99f9-29c5d4899856",
"job_status_code": "sample string 11",
"db_address_id": "f6733fea-71a7-4837-8194-db18b2a6c2b6",
"contact_id": "11ad9943-3614-497d-9cd3-19658f622a6a",
"requested_by_company_id": "e462e3ee-89b6-49b1-89ae-6ba6d4fb8490",
"requested_by_contact_id": "28d9a0ec-1b5d-4bd6-99b9-04c8fee36359",
"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-21T10:31:29.5040288+00:00",
"due_date": "2026-05-21T10:31:29.5040288+00:00",
"date_create": "2026-05-21T10:31:29.5040288+00:00",
"date_update": "2026-05-21T10:31:29.5040288+00:00",
"date_closed": "2026-05-21T10:31:29.5040288+00:00",
"suggested_user_id": "f3b066e2-ce17-4600-9bed-16ecf3a46e2e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "61791bbf-f027-492c-afd4-778330f696f2",
"db_language_id": "27d94bfa-9859-4bfa-9ef0-8ea041e4a6b5",
"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-21T10:31:29.5040288+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "12e8dcc9-424a-4d1a-96ee-34f174554b01",
"sales_organization": {
"id": "0da1a0ad-dab9-4eaf-8f17-42ed9cb59d8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147f4dca-1a42-4fa0-8302-0e4b123f245f",
"db_currency_id": "281fe6e2-c58b-4f26-8ff7-ca66239791f9",
"db_language_id": "f5534b0e-358c-466f-8538-ea1b316d29c9",
"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-21T10:31:29.5040288+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d76a82a6-6aa1-4cbf-89d1-11630aaa9d4a",
"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": "b81e0735-bdfa-4d24-8a35-9d85a2e56d14",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-21T10:31:29.5040288+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "16d08e69-7ecd-4eb5-a92f-0d79ecb4337a"
},
"suggested_date_start": "2026-05-21T10:31:29.5040288+00:00",
"skill_id": "3970bec8-d1b0-4a41-a981-cca97b6cd2d8",
"skill_code": "sample string 32",
"skill": {
"id": "d3afca33-5584-4043-8cb9-905a28b3689b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f22729c1-a6ea-4cbf-abf2-049e7774656a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0da1a0ad-dab9-4eaf-8f17-42ed9cb59d8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147f4dca-1a42-4fa0-8302-0e4b123f245f",
"db_currency_id": "281fe6e2-c58b-4f26-8ff7-ca66239791f9",
"db_language_id": "f5534b0e-358c-466f-8538-ea1b316d29c9",
"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-21T10:31:29.5040288+00:00"
},
"modified_dateutc": "2026-05-21T10:31:29.5040288+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "72c9861d-e6fc-4cb1-86fb-b3cfa3328710",
"date_reported_by_company": "2026-05-21T10:31:29.5040288+00:00",
"id2": 36,
"company_id": "69ace4df-6f95-45af-b935-2df8c803d85b",
"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": "ad2f262d-5597-4292-b5f5-22ab15d6e780",
"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-21T10:31:29.5040288+00:00"
},
"work_instruction_details_id": "0c8e0610-c5b6-4f72-91c0-f7f2174516a5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6c1e41d8-c131-4a34-aecf-925e809c7df8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "34f036bf-0e3f-41a8-a414-8fdb101ee07b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-21T10:31:29.5040288+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": "3b2d1aef-dc83-4100-ae68-e6508a67b09d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-21T10:31:29.5040288+00:00"
}