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": "35c14a70-1834-4ff4-ab6f-1e2d0bba9a4c",
"jobs_id": "1127dffb-c59e-4ac8-903d-f5bd4823007a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9e9cbd83-9c4f-4f91-9728-56e6813ad1f0",
"_parent_id": "58913e03-2f0f-4cbb-b7fc-d3b40f5039f0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c5f9625e-849c-437e-a4eb-ad1c872d2df9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "67eded87-8d4b-4223-a0e7-39ae5989e501",
"_parent_id": "b568480a-ce80-486d-8803-0413a0b1fbd9",
"root_parent_id": "3dec77cf-1744-4ce8-818d-e581d854b62e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3d4f4c8d-ad4b-4720-b2ff-76eebfef3823",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "60f3b450-59a0-488c-8a70-b602ed8f9e3b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "89be063d-256f-4885-b107-12e7a69b2a98",
"_parent_code": "sample string 6",
"sales_organization_id": "d53bde1a-66d7-4ed0-9349-ab76c8f3aa88",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "591be6cf-7e21-49fb-bf40-d30dcbe68068",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1e71454-bc66-45b6-ad9c-58fbd1c28e01",
"db_currency_id": "66c71fc1-ac11-4f2d-8fc2-6788fa82b77f",
"db_language_id": "bb1f2208-fd6a-4eed-ba0f-66403e6d6d89",
"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-11-04T06:31:52.4114018+00:00"
},
"modified_dateutc": "2026-11-04T06:31:52.4114018+00:00"
},
"equipment_model_id": "9d0707bd-cfac-42df-98ed-beb962a9148d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ba7fef94-9a38-433f-bf2d-b038f27d855f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7beda15d-d16a-4dc2-9c8e-617cc1f4d9b7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d90a28f4-9951-4159-a524-bcd00321dc24",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0e6dd2b5-038a-4a87-94ec-54e86b23974e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "591be6cf-7e21-49fb-bf40-d30dcbe68068",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1e71454-bc66-45b6-ad9c-58fbd1c28e01",
"db_currency_id": "66c71fc1-ac11-4f2d-8fc2-6788fa82b77f",
"db_language_id": "bb1f2208-fd6a-4eed-ba0f-66403e6d6d89",
"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-11-04T06:31:52.4114018+00:00"
},
"modified_dateutc": "2026-11-04T06:31:52.4114018+00:00"
},
"equipment_family_id": "0bf68fe7-38d1-47a2-b363-8dd7ba520d87",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "60f3b450-59a0-488c-8a70-b602ed8f9e3b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "89be063d-256f-4885-b107-12e7a69b2a98",
"_parent_code": "sample string 6",
"sales_organization_id": "d53bde1a-66d7-4ed0-9349-ab76c8f3aa88",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "591be6cf-7e21-49fb-bf40-d30dcbe68068",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1e71454-bc66-45b6-ad9c-58fbd1c28e01",
"db_currency_id": "66c71fc1-ac11-4f2d-8fc2-6788fa82b77f",
"db_language_id": "bb1f2208-fd6a-4eed-ba0f-66403e6d6d89",
"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-11-04T06:31:52.4114018+00:00"
},
"modified_dateutc": "2026-11-04T06:31:52.4114018+00:00"
},
"date_in_production_since": "2026-11-04T06:31:52.4114018+00:00",
"date_out_of_production_since": "2026-11-04T06:31:52.4114018+00:00",
"date_end_support": "2026-11-04T06:31:52.4114018+00:00",
"sales_organization_id": "93e99215-2c3c-4a28-baa5-ae94041d4ae5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "591be6cf-7e21-49fb-bf40-d30dcbe68068",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1e71454-bc66-45b6-ad9c-58fbd1c28e01",
"db_currency_id": "66c71fc1-ac11-4f2d-8fc2-6788fa82b77f",
"db_language_id": "bb1f2208-fd6a-4eed-ba0f-66403e6d6d89",
"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-11-04T06:31:52.4114018+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-11-04T06:31:52.4114018+00:00"
},
"project_status_id": "97670941-2c99-4f77-92bd-aaeacb09dfd1",
"project_status_code": "sample string 10",
"project_status": {
"id": "410ac10f-c5af-4f00-8f6f-a6d82e7a0f29",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0f342e9b-3561-4631-b511-60767b184dbb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "591be6cf-7e21-49fb-bf40-d30dcbe68068",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1e71454-bc66-45b6-ad9c-58fbd1c28e01",
"db_currency_id": "66c71fc1-ac11-4f2d-8fc2-6788fa82b77f",
"db_language_id": "bb1f2208-fd6a-4eed-ba0f-66403e6d6d89",
"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-11-04T06:31:52.4114018+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-04T06:31:52.4114018+00:00"
},
"company_id": "bd61fb54-6a43-462a-ab5c-a70de8ec91dd",
"company_code": "sample string 12",
"db_address_id": "fcaf6a62-32ca-4ef2-a07c-cd176ebd1072",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c8ef0eb1-7492-4610-b9b9-74ecbe95e2d1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0ce28e8d-99a9-4480-a84e-58b8b3e596af",
"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-11-04T06:31:52.4114018+00:00",
"date_create": "2026-11-04T06:31:52.4114018+00:00",
"date_update": "2026-11-04T06:31:52.4114018+00:00",
"updated_by_user_id": "ddf60c28-397b-42cf-8d78-25c0d6a95518",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-04T06:31:52.4114018+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-11-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-04T06:31:52.4114018+00:00",
"date_last_job": "2026-11-04T06:31:52.4114018+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-04T06:31:52.4114018+00:00",
"modified_dateutc": "2026-11-04T06:31:52.4114018+00:00",
"is_mobile_installation": true
},
"job_type_id": "18cedc92-b81a-43f5-9b6c-15ed645b341a",
"job_type_code": "sample string 7",
"job_type": {
"id": "cd00262b-989a-4443-804b-158a0e7f0e5e",
"name": "sample string 2",
"sales_organization_id": "65d4b408-db41-4e49-b527-f3f098bfc898",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-04T06:31:52.4114018+00:00",
"code": "sample string 7"
},
"job_priority_id": "875763fe-44eb-4434-8592-c684802b5e3c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a1467750-2553-4f67-925d-ac6dbee7e99c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "61c7e855-3648-47cd-abc6-3da0696ebe46",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "591be6cf-7e21-49fb-bf40-d30dcbe68068",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1e71454-bc66-45b6-ad9c-58fbd1c28e01",
"db_currency_id": "66c71fc1-ac11-4f2d-8fc2-6788fa82b77f",
"db_language_id": "bb1f2208-fd6a-4eed-ba0f-66403e6d6d89",
"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-11-04T06:31:52.4114018+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-04T06:31:52.4114018+00:00"
},
"job_status_id": "01aa3b78-2a2c-44f5-8b9a-525f2e0de92d",
"job_status_code": "sample string 11",
"db_address_id": "3641781e-d3a7-4671-b9fd-dccd3184ada7",
"contact_id": "22663958-2d82-4167-85ae-380570c33503",
"requested_by_company_id": "1f15155e-ae5c-4565-91d9-a87a61d80369",
"requested_by_contact_id": "27c2ab3f-50e7-4396-b767-b1acaaae8859",
"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-11-04T06:31:52.4114018+00:00",
"due_date": "2026-11-04T06:31:52.4114018+00:00",
"date_create": "2026-11-04T06:31:52.4114018+00:00",
"date_update": "2026-11-04T06:31:52.4114018+00:00",
"date_closed": "2026-11-04T06:31:52.4114018+00:00",
"suggested_user_id": "6852e6f8-bf63-451c-a4c2-3f6603c98d6e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "82f01d57-9e47-47f4-83a4-8fd0cc22dbf9",
"db_language_id": "a85193f4-9bed-4f35-8e4d-15dd67ace06e",
"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-11-04T06:31:52.4114018+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "19f484b8-e329-459c-b081-ad980f1c51ed",
"sales_organization": {
"id": "591be6cf-7e21-49fb-bf40-d30dcbe68068",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1e71454-bc66-45b6-ad9c-58fbd1c28e01",
"db_currency_id": "66c71fc1-ac11-4f2d-8fc2-6788fa82b77f",
"db_language_id": "bb1f2208-fd6a-4eed-ba0f-66403e6d6d89",
"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-11-04T06:31:52.4114018+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b86e3634-4850-455e-9675-83d231137574",
"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": "e159a17a-6b19-4bc4-b986-e1be5d45890b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-04T06:31:52.4287965+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "789cd62d-4fb5-489f-bdc3-b1af17a62a16"
},
"suggested_date_start": "2026-11-04T06:31:52.4287965+00:00",
"skill_id": "7aabe597-8fb6-49c8-9dc3-c3e9f554e44c",
"skill_code": "sample string 32",
"skill": {
"id": "e6051cdd-c0ba-4d89-8029-0f38e1dec1dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5346608e-1fe5-42f5-a2e1-d4cd9e11bd65",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "591be6cf-7e21-49fb-bf40-d30dcbe68068",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1e71454-bc66-45b6-ad9c-58fbd1c28e01",
"db_currency_id": "66c71fc1-ac11-4f2d-8fc2-6788fa82b77f",
"db_language_id": "bb1f2208-fd6a-4eed-ba0f-66403e6d6d89",
"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-11-04T06:31:52.4114018+00:00"
},
"modified_dateutc": "2026-11-04T06:31:52.4287965+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "90307f5f-4d91-4362-b741-fa51cae26795",
"date_reported_by_company": "2026-11-04T06:31:52.4287965+00:00",
"id2": 36,
"company_id": "b0d797a2-8103-4320-aff7-c9c97178d1bd",
"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": "05c9f425-5440-480a-8849-b219df40f006",
"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-11-04T06:31:52.4287965+00:00"
},
"work_instruction_details_id": "ce2e97c1-d518-4fe4-81ce-a46cf9509156",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "16439def-23a4-481e-a5f1-00c19b59a38d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7a249683-3298-421c-a74a-c29e0bc7c10e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-04T06:31:52.4287965+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": "771315ce-9e98-4550-8ebc-8dd212a3627e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-04T06:31:52.4287965+00:00"
}