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": "adaebd72-a94f-42aa-a9c7-97d1156986a0",
"jobs_id": "a24aea13-169e-47a0-80d5-1d053db44f01",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "de885d46-449f-42d6-9016-bb23ad7608d2",
"_parent_id": "be24ce6d-c55e-4897-b706-cccd4d77a642",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f59e1965-187f-4a87-9185-df3d06541a45",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f8cec519-099d-4cb0-823a-3045e5ba81b6",
"_parent_id": "47864d66-2697-454e-a106-e8a22800afe3",
"root_parent_id": "7632a6b1-f09b-4a6d-9cc7-0a977520913d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f6815221-4aa3-40c2-91cc-c247ee01eace",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8158e48c-2245-480e-a8ba-1f1658bb76b9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "079292e9-b602-4e79-b032-025ef80cb9e8",
"_parent_code": "sample string 6",
"sales_organization_id": "1294a8b1-3612-44da-9ef6-50a54a08697c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "92826256-fa54-4c37-b231-d8edd08e73dd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a6b0753-2321-48b3-a24a-aae64e6acb0f",
"db_currency_id": "2f089da8-9419-4b78-a9a8-e0d14bb6e256",
"db_language_id": "d0cc3ad0-d30f-4d81-beca-625526ee8c4c",
"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-08-20T02:35:09.5556257+00:00"
},
"modified_dateutc": "2026-08-20T02:35:09.5556257+00:00"
},
"equipment_model_id": "52c5ffcf-cb81-45ac-8997-b8929d42cd8f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b1d24bb6-3ce2-43be-baa3-fc034050699a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7d8a5d0a-f8a1-46e4-99ef-2d07a7a53f6f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d26f67c5-4f03-479d-b390-988ec06e3b40",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "41923313-62fa-484c-bd0a-157c5df5457d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "92826256-fa54-4c37-b231-d8edd08e73dd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a6b0753-2321-48b3-a24a-aae64e6acb0f",
"db_currency_id": "2f089da8-9419-4b78-a9a8-e0d14bb6e256",
"db_language_id": "d0cc3ad0-d30f-4d81-beca-625526ee8c4c",
"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-08-20T02:35:09.5556257+00:00"
},
"modified_dateutc": "2026-08-20T02:35:09.5556257+00:00"
},
"equipment_family_id": "3f77e4d6-2fec-4153-9537-bd629ddd0fb6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8158e48c-2245-480e-a8ba-1f1658bb76b9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "079292e9-b602-4e79-b032-025ef80cb9e8",
"_parent_code": "sample string 6",
"sales_organization_id": "1294a8b1-3612-44da-9ef6-50a54a08697c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "92826256-fa54-4c37-b231-d8edd08e73dd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a6b0753-2321-48b3-a24a-aae64e6acb0f",
"db_currency_id": "2f089da8-9419-4b78-a9a8-e0d14bb6e256",
"db_language_id": "d0cc3ad0-d30f-4d81-beca-625526ee8c4c",
"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-08-20T02:35:09.5556257+00:00"
},
"modified_dateutc": "2026-08-20T02:35:09.5556257+00:00"
},
"date_in_production_since": "2026-08-20T02:35:09.5556257+00:00",
"date_out_of_production_since": "2026-08-20T02:35:09.5556257+00:00",
"date_end_support": "2026-08-20T02:35:09.5556257+00:00",
"sales_organization_id": "72b0bc53-8720-44b2-b76b-5d339b808138",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "92826256-fa54-4c37-b231-d8edd08e73dd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a6b0753-2321-48b3-a24a-aae64e6acb0f",
"db_currency_id": "2f089da8-9419-4b78-a9a8-e0d14bb6e256",
"db_language_id": "d0cc3ad0-d30f-4d81-beca-625526ee8c4c",
"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-08-20T02:35:09.5556257+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-08-20T02:35:09.5556257+00:00"
},
"project_status_id": "0507fd0f-382c-47e3-adfe-6eae28b5d8f4",
"project_status_code": "sample string 10",
"project_status": {
"id": "06f5b9b4-ff10-4c10-a7e8-2ff03d19c5d1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3f7f263c-9834-4d15-8c2b-1af61aaba2fd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "92826256-fa54-4c37-b231-d8edd08e73dd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a6b0753-2321-48b3-a24a-aae64e6acb0f",
"db_currency_id": "2f089da8-9419-4b78-a9a8-e0d14bb6e256",
"db_language_id": "d0cc3ad0-d30f-4d81-beca-625526ee8c4c",
"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-08-20T02:35:09.5556257+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-20T02:35:09.5556257+00:00"
},
"company_id": "a70330f1-f410-4b69-8872-57549b0654b4",
"company_code": "sample string 12",
"db_address_id": "f810a31e-22f4-4c5a-8b47-cbfa763e8c26",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "66788aab-2677-496d-9e2f-26762b9370ed",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8c2a8033-dbd3-4c29-ad9d-53bf3dc25b40",
"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-08-20T02:35:09.5556257+00:00",
"date_create": "2026-08-20T02:35:09.5556257+00:00",
"date_update": "2026-08-20T02:35:09.5556257+00:00",
"updated_by_user_id": "e12b1ead-5e6b-4c9b-afde-6060a7307f11",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-20T02:35:09.5556257+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-08-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-20T02:35:09.5556257+00:00",
"date_last_job": "2026-08-20T02:35:09.5556257+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-20T02:35:09.5556257+00:00",
"modified_dateutc": "2026-08-20T02:35:09.5556257+00:00",
"is_mobile_installation": true
},
"job_type_id": "001fecc1-75ec-4310-ae57-d840dec1fcb2",
"job_type_code": "sample string 7",
"job_type": {
"id": "a0a37aa6-4183-45e6-bab4-90e004f5fb30",
"name": "sample string 2",
"sales_organization_id": "1b47b5fa-e5f4-42b3-844f-4d003018c0b9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-20T02:35:09.5556257+00:00",
"code": "sample string 7"
},
"job_priority_id": "3734ee15-5735-40ab-a622-acfeafb0bc64",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "157c21b6-a041-4919-8e1f-8ad810074a5b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b93796f8-a938-437d-8173-f288f4547efb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "92826256-fa54-4c37-b231-d8edd08e73dd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a6b0753-2321-48b3-a24a-aae64e6acb0f",
"db_currency_id": "2f089da8-9419-4b78-a9a8-e0d14bb6e256",
"db_language_id": "d0cc3ad0-d30f-4d81-beca-625526ee8c4c",
"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-08-20T02:35:09.5556257+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-20T02:35:09.5556257+00:00"
},
"job_status_id": "7296cf76-adba-41db-8696-ecacf0b6f312",
"job_status_code": "sample string 11",
"db_address_id": "ef64ced4-4301-49d4-a3fd-39aa760ff232",
"contact_id": "2d0e4de3-b174-4607-8d1c-90a3eb1c59d4",
"requested_by_company_id": "74200179-c2dc-4ae5-9c6e-ae677608455f",
"requested_by_contact_id": "eeef890c-8b4e-4be4-a364-3a9863363430",
"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-08-20T02:35:09.5556257+00:00",
"due_date": "2026-08-20T02:35:09.5556257+00:00",
"date_create": "2026-08-20T02:35:09.5556257+00:00",
"date_update": "2026-08-20T02:35:09.5556257+00:00",
"date_closed": "2026-08-20T02:35:09.5556257+00:00",
"suggested_user_id": "653123c3-8a11-4354-b902-f1b2891e7763",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "682b78c4-36de-4937-9dc9-13ee9a1772de",
"db_language_id": "128bfe29-2340-43ad-a1d5-240fea6a0a5c",
"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-08-20T02:35:09.5556257+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bf072adc-69ae-460f-87e4-3dde5424f7ae",
"sales_organization": {
"id": "92826256-fa54-4c37-b231-d8edd08e73dd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a6b0753-2321-48b3-a24a-aae64e6acb0f",
"db_currency_id": "2f089da8-9419-4b78-a9a8-e0d14bb6e256",
"db_language_id": "d0cc3ad0-d30f-4d81-beca-625526ee8c4c",
"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-08-20T02:35:09.5556257+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "57c91cc8-bbc5-4340-ad53-e77a77f6a5be",
"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": "e6ff8bd8-6862-46c8-a571-0e5e4b5c867e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-20T02:35:09.5556257+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "aaca9428-112f-4d1f-a3e7-848c9d196d3a"
},
"suggested_date_start": "2026-08-20T02:35:09.5556257+00:00",
"skill_id": "fd07bfc8-34e5-4a71-95c7-b26a8c03b8de",
"skill_code": "sample string 32",
"skill": {
"id": "569af887-b20f-4f12-b1c4-d8da2f846d68",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ba1f7c98-321e-4084-9807-76c03e2e2654",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "92826256-fa54-4c37-b231-d8edd08e73dd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a6b0753-2321-48b3-a24a-aae64e6acb0f",
"db_currency_id": "2f089da8-9419-4b78-a9a8-e0d14bb6e256",
"db_language_id": "d0cc3ad0-d30f-4d81-beca-625526ee8c4c",
"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-08-20T02:35:09.5556257+00:00"
},
"modified_dateutc": "2026-08-20T02:35:09.5556257+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b06ed1c0-2947-40fb-a02f-93212d0a24bd",
"date_reported_by_company": "2026-08-20T02:35:09.5556257+00:00",
"id2": 36,
"company_id": "6b01d899-e8f4-4351-b9cc-75bbfd21d527",
"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": "cc72df94-c915-4d5a-b19c-63b73395167a",
"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-08-20T02:35:09.5556257+00:00"
},
"work_instruction_details_id": "35f83537-d6a8-4b83-a178-a7827973ab33",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9460f082-eda6-498e-97ad-15dcedc85a12",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5258b582-5bb0-4e50-a822-b9468c1cd1ea",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-20T02:35:09.5556257+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": "2ffe98a6-b1f8-4816-ab50-77beba7adfab",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-20T02:35:09.5556257+00:00"
}