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": "a87c1d42-a57f-4a6c-a804-45874557cc40",
"jobs_id": "5d5592dc-3202-4cbb-93dd-36e3ff2f9845",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "722f8725-b0d4-46c1-a0b5-71eb5a5bce94",
"_parent_id": "d8edf599-a95b-4405-993e-0313cb98325d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fef887fe-b444-45c6-bbfd-7bd121ce824b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e2aef1f2-40d3-4668-b6fb-12a9976eba56",
"_parent_id": "33ef34e8-93ad-46d8-9b4f-bad04761ae44",
"root_parent_id": "2fe9f70c-4c98-40b1-8d09-2bf022fa7581",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "32df2012-cb34-4ba5-a6b1-1f143b18873a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "98835e80-52ef-4980-8374-7ac5e4732b7c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0480ce65-000d-474e-b153-f52a2c389c99",
"_parent_code": "sample string 6",
"sales_organization_id": "19a38b2d-5a6e-4ce5-9316-ed6c54016b45",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e15902a6-df4e-43b4-ae8e-966c990b5c3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc2a1b18-f224-4943-bf45-fc11bc6540c7",
"db_currency_id": "bfd6e5a5-ed3a-42d2-b09f-d1de0da96bc7",
"db_language_id": "d1d68fbb-c9bb-46cf-8ef5-4bc8e3ac282a",
"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-01-21T05:31:43.8349688+00:00"
},
"modified_dateutc": "2026-01-21T05:31:43.8349688+00:00"
},
"equipment_model_id": "9e2dbb4d-1606-40db-85ec-70e2926e0c7f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b2d92a61-6c22-4b54-972f-80591745dfba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "71c18f67-084d-4310-9019-983c57bf1f8b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6e256be0-cb3a-4661-a324-f3f776134df8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ca60f1ed-915b-4cae-8fba-bca9ba69d77d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e15902a6-df4e-43b4-ae8e-966c990b5c3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc2a1b18-f224-4943-bf45-fc11bc6540c7",
"db_currency_id": "bfd6e5a5-ed3a-42d2-b09f-d1de0da96bc7",
"db_language_id": "d1d68fbb-c9bb-46cf-8ef5-4bc8e3ac282a",
"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-01-21T05:31:43.8349688+00:00"
},
"modified_dateutc": "2026-01-21T05:31:43.8349688+00:00"
},
"equipment_family_id": "e23e379c-7e1b-42d8-b24e-dbf2b144d2b6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "98835e80-52ef-4980-8374-7ac5e4732b7c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0480ce65-000d-474e-b153-f52a2c389c99",
"_parent_code": "sample string 6",
"sales_organization_id": "19a38b2d-5a6e-4ce5-9316-ed6c54016b45",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e15902a6-df4e-43b4-ae8e-966c990b5c3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc2a1b18-f224-4943-bf45-fc11bc6540c7",
"db_currency_id": "bfd6e5a5-ed3a-42d2-b09f-d1de0da96bc7",
"db_language_id": "d1d68fbb-c9bb-46cf-8ef5-4bc8e3ac282a",
"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-01-21T05:31:43.8349688+00:00"
},
"modified_dateutc": "2026-01-21T05:31:43.8349688+00:00"
},
"date_in_production_since": "2026-01-21T05:31:43.8349688+00:00",
"date_out_of_production_since": "2026-01-21T05:31:43.8349688+00:00",
"date_end_support": "2026-01-21T05:31:43.8349688+00:00",
"sales_organization_id": "b18e74eb-8dff-47e2-ae1a-8dba00bfb6f2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e15902a6-df4e-43b4-ae8e-966c990b5c3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc2a1b18-f224-4943-bf45-fc11bc6540c7",
"db_currency_id": "bfd6e5a5-ed3a-42d2-b09f-d1de0da96bc7",
"db_language_id": "d1d68fbb-c9bb-46cf-8ef5-4bc8e3ac282a",
"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-01-21T05:31:43.8349688+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-01-21T05:31:43.8349688+00:00"
},
"project_status_id": "cd94a4db-32c7-4b9c-8337-1df288fa415a",
"project_status_code": "sample string 10",
"project_status": {
"id": "87a0c6c4-4508-412b-9dc1-e86c4f317f2f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c479af0e-420e-4a3e-9540-e7704d2f6526",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e15902a6-df4e-43b4-ae8e-966c990b5c3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc2a1b18-f224-4943-bf45-fc11bc6540c7",
"db_currency_id": "bfd6e5a5-ed3a-42d2-b09f-d1de0da96bc7",
"db_language_id": "d1d68fbb-c9bb-46cf-8ef5-4bc8e3ac282a",
"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-01-21T05:31:43.8349688+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-21T05:31:43.8349688+00:00"
},
"company_id": "80d422f3-95d8-404d-99fd-463260165c79",
"company_code": "sample string 12",
"db_address_id": "0f1752e9-02ed-4b3d-84c5-29c519b7eb22",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ce6166c8-6586-44f6-8135-c978750e0ec6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8bfbccf2-ddf4-4adc-b36f-6f1190714894",
"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-01-21T05:31:43.8349688+00:00",
"date_create": "2026-01-21T05:31:43.8349688+00:00",
"date_update": "2026-01-21T05:31:43.8349688+00:00",
"updated_by_user_id": "ebe632ab-6231-4722-a8b1-cb425144bc43",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-21T05:31:43.8349688+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-01-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-21T05:31:43.8349688+00:00",
"date_last_job": "2026-01-21T05:31:43.8349688+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-21T05:31:43.8349688+00:00",
"modified_dateutc": "2026-01-21T05:31:43.8349688+00:00",
"is_mobile_installation": true
},
"job_type_id": "3a7d9b8f-797d-4461-a8d9-151911acc2c4",
"job_type_code": "sample string 7",
"job_type": {
"id": "7c523341-81e2-4166-ada3-ccf294d9acbd",
"name": "sample string 2",
"sales_organization_id": "fb465c20-46c7-415d-a282-adff99f70954",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-21T05:31:43.8349688+00:00",
"code": "sample string 7"
},
"job_priority_id": "99fa2b52-0d47-4d3c-a3d8-ab336c48f9a0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "22cf8ea5-57e3-410f-939d-22fe9153d3b0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2ba31965-9236-4762-a3a2-6f6063eb71eb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e15902a6-df4e-43b4-ae8e-966c990b5c3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc2a1b18-f224-4943-bf45-fc11bc6540c7",
"db_currency_id": "bfd6e5a5-ed3a-42d2-b09f-d1de0da96bc7",
"db_language_id": "d1d68fbb-c9bb-46cf-8ef5-4bc8e3ac282a",
"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-01-21T05:31:43.8349688+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-21T05:31:43.8349688+00:00"
},
"job_status_id": "a6aca57d-287a-481b-b01a-f6e1e447feae",
"job_status_code": "sample string 11",
"db_address_id": "906b321a-9557-40dd-9ba6-7dd6f7372df7",
"contact_id": "8b40d225-8db7-4a8a-834a-c7c004cda22c",
"requested_by_company_id": "72dc04b4-b700-4115-adb9-6f87570ba500",
"requested_by_contact_id": "3ad49c4a-424a-4bcd-8e77-b3f9105bf901",
"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-01-21T05:31:43.8349688+00:00",
"due_date": "2026-01-21T05:31:43.8349688+00:00",
"date_create": "2026-01-21T05:31:43.8349688+00:00",
"date_update": "2026-01-21T05:31:43.8349688+00:00",
"date_closed": "2026-01-21T05:31:43.8349688+00:00",
"suggested_user_id": "46e3ca9a-dc73-406c-9127-54f04957799b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "692bb270-42b0-49fb-bc0b-999c68a0bfc7",
"db_language_id": "c3f9a6c5-f73c-4451-acc9-5ab8368437c3",
"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-01-21T05:31:43.8505863+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "89705930-5edc-49b8-bf52-e931635a1beb",
"sales_organization": {
"id": "e15902a6-df4e-43b4-ae8e-966c990b5c3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc2a1b18-f224-4943-bf45-fc11bc6540c7",
"db_currency_id": "bfd6e5a5-ed3a-42d2-b09f-d1de0da96bc7",
"db_language_id": "d1d68fbb-c9bb-46cf-8ef5-4bc8e3ac282a",
"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-01-21T05:31:43.8349688+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "553672e0-1167-477e-9f31-74c7ae5f4a4f",
"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": "19a8825a-c874-4496-81d8-f5ddd5ad244c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-21T05:31:43.8505863+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cc8cdad0-23d1-416c-87ea-691696905fe8"
},
"suggested_date_start": "2026-01-21T05:31:43.8505863+00:00",
"skill_id": "1bd6a34e-88d2-4313-bfbe-faa98d47c6c9",
"skill_code": "sample string 32",
"skill": {
"id": "51feb08e-8782-4cf4-88e8-2b24579ee1f9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "79d1836a-fa21-4c35-8e82-be888bb7fc44",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e15902a6-df4e-43b4-ae8e-966c990b5c3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc2a1b18-f224-4943-bf45-fc11bc6540c7",
"db_currency_id": "bfd6e5a5-ed3a-42d2-b09f-d1de0da96bc7",
"db_language_id": "d1d68fbb-c9bb-46cf-8ef5-4bc8e3ac282a",
"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-01-21T05:31:43.8349688+00:00"
},
"modified_dateutc": "2026-01-21T05:31:43.8505863+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d448bff3-0294-4ba4-91fd-8eac062e7c14",
"date_reported_by_company": "2026-01-21T05:31:43.8505863+00:00",
"id2": 36,
"company_id": "8aae0e64-819c-4908-b5a4-e9a7e3dd05e0",
"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": "d79f3604-5de4-484d-8964-60b3747a6080",
"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-01-21T05:31:43.8505863+00:00"
},
"work_instruction_details_id": "1d23ecf2-d3cd-49d1-9747-62e1d95642d3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ef1a5b37-d2ac-4106-a447-18e1a0e205ce",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3b019891-ea64-4520-b22b-f4b0d93fb000",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-21T05:31:43.8505863+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": "d056b1be-95d3-46f3-ba7e-36bcbe9a1e12",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-21T05:31:43.8505863+00:00"
}