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": "0295a17c-015d-40ba-8925-5c8964028b75",
"jobs_id": "7bca5bc6-6551-43e4-9c4d-dcbe0d4b63d3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5bb4d371-4aa3-459c-85fe-892caa7daacb",
"_parent_id": "c73e1a63-2d52-4a28-bbac-15969a12d077",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2fa8394c-01d0-47de-b05a-601513499475",
"project_reference_back_office": "sample string 5",
"project": {
"id": "380201e3-7462-4912-bea3-5359f5560f80",
"_parent_id": "ca890d39-bad0-40d9-991a-c0fead1f7f01",
"root_parent_id": "89d5d720-634d-4d7a-9334-97dc31c14cdc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "60ab39e4-3c97-4ebc-b86d-1b0703d9157f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6732d27b-72fb-4533-a38a-9c54b3b08bc9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a9019c83-1486-4aac-843f-ad05fdb02c70",
"_parent_code": "sample string 6",
"sales_organization_id": "bac5a000-9638-41f2-bc78-cf4416447d0a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f6d5da12-8d4d-4f26-9361-703e1399ef6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ba45ece-1810-47d9-ab6e-72aaef9a466c",
"db_currency_id": "07b090f4-6371-4e79-9d85-f997473b226b",
"db_language_id": "441d14b5-94ad-44c5-bc55-a9739e60dbb5",
"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-04-03T09:13:44.5105899+00:00"
},
"modified_dateutc": "2026-04-03T09:13:44.526215+00:00"
},
"equipment_model_id": "afe58402-46e5-4f63-9dde-faa791b34611",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f22b3e80-2889-468d-93db-ec56ac93450f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "55c59a76-ee6c-42bd-8de5-9dab416eedf3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4e4fddea-d252-4d09-afaf-1dbc9ef2be53",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9edaaa97-94db-4963-914f-5ac1307dea4c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f6d5da12-8d4d-4f26-9361-703e1399ef6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ba45ece-1810-47d9-ab6e-72aaef9a466c",
"db_currency_id": "07b090f4-6371-4e79-9d85-f997473b226b",
"db_language_id": "441d14b5-94ad-44c5-bc55-a9739e60dbb5",
"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-04-03T09:13:44.5105899+00:00"
},
"modified_dateutc": "2026-04-03T09:13:44.526215+00:00"
},
"equipment_family_id": "ce9a4e59-d4f1-4027-b79d-4033da01f63f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6732d27b-72fb-4533-a38a-9c54b3b08bc9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a9019c83-1486-4aac-843f-ad05fdb02c70",
"_parent_code": "sample string 6",
"sales_organization_id": "bac5a000-9638-41f2-bc78-cf4416447d0a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f6d5da12-8d4d-4f26-9361-703e1399ef6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ba45ece-1810-47d9-ab6e-72aaef9a466c",
"db_currency_id": "07b090f4-6371-4e79-9d85-f997473b226b",
"db_language_id": "441d14b5-94ad-44c5-bc55-a9739e60dbb5",
"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-04-03T09:13:44.5105899+00:00"
},
"modified_dateutc": "2026-04-03T09:13:44.526215+00:00"
},
"date_in_production_since": "2026-04-03T09:13:44.526215+00:00",
"date_out_of_production_since": "2026-04-03T09:13:44.526215+00:00",
"date_end_support": "2026-04-03T09:13:44.526215+00:00",
"sales_organization_id": "5ebf9f59-d0dd-4924-9843-8b507827e644",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f6d5da12-8d4d-4f26-9361-703e1399ef6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ba45ece-1810-47d9-ab6e-72aaef9a466c",
"db_currency_id": "07b090f4-6371-4e79-9d85-f997473b226b",
"db_language_id": "441d14b5-94ad-44c5-bc55-a9739e60dbb5",
"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-04-03T09:13:44.5105899+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-04-03T09:13:44.526215+00:00"
},
"project_status_id": "ca7a8c23-d7df-462f-a215-848f01d203d9",
"project_status_code": "sample string 10",
"project_status": {
"id": "25005d85-1781-4dbe-a0ef-cf2420a5ea8f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d99623e7-d17b-4778-815a-303c26a2267c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f6d5da12-8d4d-4f26-9361-703e1399ef6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ba45ece-1810-47d9-ab6e-72aaef9a466c",
"db_currency_id": "07b090f4-6371-4e79-9d85-f997473b226b",
"db_language_id": "441d14b5-94ad-44c5-bc55-a9739e60dbb5",
"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-04-03T09:13:44.5105899+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-03T09:13:44.526215+00:00"
},
"company_id": "1cf37ee5-a457-41fe-9292-997ed7ec6556",
"company_code": "sample string 12",
"db_address_id": "60b11007-4041-4f76-8f84-88994cfb5e90",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "746f2529-4775-419d-a559-23250ccad97c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f60ff2e2-cb76-4704-a470-e8bb38497476",
"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-04-03T09:13:44.526215+00:00",
"date_create": "2026-04-03T09:13:44.526215+00:00",
"date_update": "2026-04-03T09:13:44.526215+00:00",
"updated_by_user_id": "510e0470-021b-4640-9392-4b6e11392cc2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-03T09:13:44.526215+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-04-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-03T09:13:44.526215+00:00",
"date_last_job": "2026-04-03T09:13:44.526215+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-03T09:13:44.526215+00:00",
"modified_dateutc": "2026-04-03T09:13:44.526215+00:00",
"is_mobile_installation": true
},
"job_type_id": "45db8491-45b1-4ec0-beb2-04b3c6179cb8",
"job_type_code": "sample string 7",
"job_type": {
"id": "8e3346b7-4757-48ff-896f-8f23ce5805f3",
"name": "sample string 2",
"sales_organization_id": "19b61dad-dd4d-470c-961b-ca17783797f1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-03T09:13:44.526215+00:00",
"code": "sample string 7"
},
"job_priority_id": "103d9540-ba33-46a6-bc53-f7406394388e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "665090a3-548b-41c3-990d-86a951f8cb97",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0fe76ce8-4b30-4d3b-8d39-e81fb8ac4411",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f6d5da12-8d4d-4f26-9361-703e1399ef6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ba45ece-1810-47d9-ab6e-72aaef9a466c",
"db_currency_id": "07b090f4-6371-4e79-9d85-f997473b226b",
"db_language_id": "441d14b5-94ad-44c5-bc55-a9739e60dbb5",
"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-04-03T09:13:44.5105899+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-03T09:13:44.526215+00:00"
},
"job_status_id": "d8c12d16-496a-45ae-adf0-34e775d2a1c7",
"job_status_code": "sample string 11",
"db_address_id": "625bfb13-b87e-434b-8842-bdcea3e8843f",
"contact_id": "eb80da77-cfa5-49c5-80e5-2df20c52d4bb",
"requested_by_company_id": "8737d158-ea53-4a65-a0ff-1843bd9d06bc",
"requested_by_contact_id": "cd66fb24-62b0-4fb7-ac6f-cd475970ddc7",
"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-04-03T09:13:44.526215+00:00",
"due_date": "2026-04-03T09:13:44.526215+00:00",
"date_create": "2026-04-03T09:13:44.526215+00:00",
"date_update": "2026-04-03T09:13:44.526215+00:00",
"date_closed": "2026-04-03T09:13:44.526215+00:00",
"suggested_user_id": "d75a2e5a-a2df-4ae6-96f4-c547959292b7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5c20bcf9-d501-4f4b-85c5-106e7c8a438e",
"db_language_id": "388ba7d2-e3e9-4def-9fdd-87e381c59883",
"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-04-03T09:13:44.526215+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "afedb837-5ae4-4348-9b2f-c01d51f54749",
"sales_organization": {
"id": "f6d5da12-8d4d-4f26-9361-703e1399ef6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ba45ece-1810-47d9-ab6e-72aaef9a466c",
"db_currency_id": "07b090f4-6371-4e79-9d85-f997473b226b",
"db_language_id": "441d14b5-94ad-44c5-bc55-a9739e60dbb5",
"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-04-03T09:13:44.5105899+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "63b1e6fd-a2b6-42c8-8e8a-0820e4f3d823",
"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": "dc0c258c-18e5-493f-9197-6179bde1135a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-03T09:13:44.526215+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4d3b5735-86f5-4af2-a791-12c0bb4ce8ef"
},
"suggested_date_start": "2026-04-03T09:13:44.526215+00:00",
"skill_id": "4a8bd41a-b25a-4d8e-809b-022d98ca3e33",
"skill_code": "sample string 32",
"skill": {
"id": "c79c771d-2afd-4583-b59c-096818f64d53",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "74d594e2-a4b1-45f1-be93-f88034c569cc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f6d5da12-8d4d-4f26-9361-703e1399ef6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ba45ece-1810-47d9-ab6e-72aaef9a466c",
"db_currency_id": "07b090f4-6371-4e79-9d85-f997473b226b",
"db_language_id": "441d14b5-94ad-44c5-bc55-a9739e60dbb5",
"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-04-03T09:13:44.5105899+00:00"
},
"modified_dateutc": "2026-04-03T09:13:44.526215+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "883485f7-0a6d-4652-a80b-c4e662df4537",
"date_reported_by_company": "2026-04-03T09:13:44.526215+00:00",
"id2": 36,
"company_id": "07e1935e-1cf2-47a8-81c5-979ce87a44aa",
"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": "f05b8c6f-a7eb-4112-abe5-44a9f9a0a5c4",
"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-04-03T09:13:44.526215+00:00"
},
"work_instruction_details_id": "30a4be0a-7975-46ef-9fdb-560a6e4c958c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d9a9f0a4-a578-468f-ae93-f17e808bf81a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "daacca62-7850-47c6-b3b6-bfa53fd73385",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-03T09:13:44.526215+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": "478b6fdb-b65c-44bf-9ab8-96a09eedd822",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-03T09:13:44.526215+00:00"
}