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": "760ad6e4-08c9-4257-a7ec-30f59d7fa004",
"jobs_id": "785fc2a5-ea5e-4938-95ff-a499725c14f3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "edfb6d0b-19d8-43cc-bd8e-43131b2a1b1b",
"_parent_id": "d6b6f9c5-f514-4115-a265-11f64a814b22",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "475ff849-6bf9-4369-b531-f98c41d722b2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f8fcc875-ff14-4a7e-9426-ae1ca6cb6d78",
"_parent_id": "20646026-41e4-44d4-85a2-732accb258da",
"root_parent_id": "771cb489-a9be-4f60-ba02-9e21fc9112fc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9649afc9-e467-4de7-8e9c-de3f844d00ff",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e7891a93-02a6-477d-b4cc-5161db570050",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dbc5752f-29ef-4a25-b5b2-3fbc67155a14",
"_parent_code": "sample string 6",
"sales_organization_id": "46b1d930-8c74-4e69-bd41-b4f7dfaf55b2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8739c601-3efd-4878-88a4-42dc635913a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9357b1c9-3fa6-47c9-94f9-1bcfb27ba0f8",
"db_currency_id": "c717765a-e4eb-4690-b4d8-d090bdf8d4b5",
"db_language_id": "928d355c-5f48-4899-94ab-3803492c1c9b",
"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-02-16T15:05:18.1951793+00:00"
},
"modified_dateutc": "2026-02-16T15:05:18.1951793+00:00"
},
"equipment_model_id": "28976bab-5c47-4926-8d59-49aedd520c46",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ee7849fd-f576-4cdf-bd9b-37a16ff34128",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b33f8234-3b73-474d-9650-83679bf35f5b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5a9ef4ab-8fdd-4257-9593-f39ac5e9eea7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d576f0cd-e44c-474b-b6bb-884221710c36",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8739c601-3efd-4878-88a4-42dc635913a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9357b1c9-3fa6-47c9-94f9-1bcfb27ba0f8",
"db_currency_id": "c717765a-e4eb-4690-b4d8-d090bdf8d4b5",
"db_language_id": "928d355c-5f48-4899-94ab-3803492c1c9b",
"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-02-16T15:05:18.1951793+00:00"
},
"modified_dateutc": "2026-02-16T15:05:18.1951793+00:00"
},
"equipment_family_id": "b9b9525c-580b-414c-85a9-4f287275c2d0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e7891a93-02a6-477d-b4cc-5161db570050",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dbc5752f-29ef-4a25-b5b2-3fbc67155a14",
"_parent_code": "sample string 6",
"sales_organization_id": "46b1d930-8c74-4e69-bd41-b4f7dfaf55b2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8739c601-3efd-4878-88a4-42dc635913a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9357b1c9-3fa6-47c9-94f9-1bcfb27ba0f8",
"db_currency_id": "c717765a-e4eb-4690-b4d8-d090bdf8d4b5",
"db_language_id": "928d355c-5f48-4899-94ab-3803492c1c9b",
"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-02-16T15:05:18.1951793+00:00"
},
"modified_dateutc": "2026-02-16T15:05:18.1951793+00:00"
},
"date_in_production_since": "2026-02-16T15:05:18.1951793+00:00",
"date_out_of_production_since": "2026-02-16T15:05:18.1951793+00:00",
"date_end_support": "2026-02-16T15:05:18.1951793+00:00",
"sales_organization_id": "85020c37-756e-4965-80c4-7f97569912b2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8739c601-3efd-4878-88a4-42dc635913a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9357b1c9-3fa6-47c9-94f9-1bcfb27ba0f8",
"db_currency_id": "c717765a-e4eb-4690-b4d8-d090bdf8d4b5",
"db_language_id": "928d355c-5f48-4899-94ab-3803492c1c9b",
"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-02-16T15:05:18.1951793+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-02-16T15:05:18.1951793+00:00"
},
"project_status_id": "d14a0fe8-ef5d-4326-8bae-7bbe30765960",
"project_status_code": "sample string 10",
"project_status": {
"id": "10e1f4c1-c137-4c35-aa7d-5e151dbe2f21",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f2bc4de6-6783-49b6-a831-e05ad14511fa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8739c601-3efd-4878-88a4-42dc635913a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9357b1c9-3fa6-47c9-94f9-1bcfb27ba0f8",
"db_currency_id": "c717765a-e4eb-4690-b4d8-d090bdf8d4b5",
"db_language_id": "928d355c-5f48-4899-94ab-3803492c1c9b",
"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-02-16T15:05:18.1951793+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-16T15:05:18.1951793+00:00"
},
"company_id": "c59e01dd-29ae-43d2-a493-6b707ce1f57f",
"company_code": "sample string 12",
"db_address_id": "425dc0e7-d7f6-4c42-8648-0201496c19e1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "37110f53-cb2a-4df8-b7ab-77558623c9bd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "72a6ecd7-6433-45e0-9943-c20538171ecc",
"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-02-16T15:05:18.1951793+00:00",
"date_create": "2026-02-16T15:05:18.1951793+00:00",
"date_update": "2026-02-16T15:05:18.1951793+00:00",
"updated_by_user_id": "57523d3d-a281-45e5-9fa5-e8356a519dfa",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-16T15:05:18.1951793+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-02-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-16T15:05:18.1951793+00:00",
"date_last_job": "2026-02-16T15:05:18.1951793+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-16T15:05:18.1951793+00:00",
"modified_dateutc": "2026-02-16T15:05:18.1951793+00:00",
"is_mobile_installation": true
},
"job_type_id": "1e59b401-638c-4ab9-96cf-e9e6db3910ac",
"job_type_code": "sample string 7",
"job_type": {
"id": "7524aedc-029f-44fe-b935-a90ffdefb56b",
"name": "sample string 2",
"sales_organization_id": "ce530bc5-4151-414b-acf2-cd6f15078a04",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-16T15:05:18.1951793+00:00",
"code": "sample string 7"
},
"job_priority_id": "58b3b6e4-c3f0-4e9f-826b-c25e1bfe095b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ce7891de-3a6c-44c3-942a-9e566d744bea",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "deb689e0-8f74-451f-b63e-e0fa1a06b74e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8739c601-3efd-4878-88a4-42dc635913a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9357b1c9-3fa6-47c9-94f9-1bcfb27ba0f8",
"db_currency_id": "c717765a-e4eb-4690-b4d8-d090bdf8d4b5",
"db_language_id": "928d355c-5f48-4899-94ab-3803492c1c9b",
"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-02-16T15:05:18.1951793+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-16T15:05:18.1951793+00:00"
},
"job_status_id": "b71633b7-2ea1-4750-8dff-d5fd8f68ddb6",
"job_status_code": "sample string 11",
"db_address_id": "a8009063-0e5b-4686-82d2-40b926c89b66",
"contact_id": "0b1c7ad9-9437-4275-84c8-4b78a9e4c6f4",
"requested_by_company_id": "2ec50cd4-3404-4615-a654-16390850fe7c",
"requested_by_contact_id": "a2789fc5-505c-450c-94e8-db5c48818062",
"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-02-16T15:05:18.1951793+00:00",
"due_date": "2026-02-16T15:05:18.1951793+00:00",
"date_create": "2026-02-16T15:05:18.1951793+00:00",
"date_update": "2026-02-16T15:05:18.1951793+00:00",
"date_closed": "2026-02-16T15:05:18.1951793+00:00",
"suggested_user_id": "c0521d08-6e54-4b70-9619-81524b7453bd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5b549b8b-f344-4cfa-8d93-354ff8d4b939",
"db_language_id": "15009677-3276-4023-81ad-260b50eb17ec",
"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-02-16T15:05:18.1951793+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "20388cd2-725a-4880-bbab-9aaff6552872",
"sales_organization": {
"id": "8739c601-3efd-4878-88a4-42dc635913a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9357b1c9-3fa6-47c9-94f9-1bcfb27ba0f8",
"db_currency_id": "c717765a-e4eb-4690-b4d8-d090bdf8d4b5",
"db_language_id": "928d355c-5f48-4899-94ab-3803492c1c9b",
"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-02-16T15:05:18.1951793+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f2ca7471-59f5-4130-9dfd-0342ff658906",
"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": "9cfd3c52-1e79-4255-ae29-07595b73fbbe",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-16T15:05:18.1951793+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8236a04e-5533-4f09-90c6-565af2c4fa8a"
},
"suggested_date_start": "2026-02-16T15:05:18.1951793+00:00",
"skill_id": "e7f938a0-3960-4f5d-93cd-f5c6ed760549",
"skill_code": "sample string 32",
"skill": {
"id": "85c75c26-2925-4020-a83d-0775ac7ba5f6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "28e1fb7c-31ac-4892-bb9e-8b6e53d533c6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8739c601-3efd-4878-88a4-42dc635913a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9357b1c9-3fa6-47c9-94f9-1bcfb27ba0f8",
"db_currency_id": "c717765a-e4eb-4690-b4d8-d090bdf8d4b5",
"db_language_id": "928d355c-5f48-4899-94ab-3803492c1c9b",
"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-02-16T15:05:18.1951793+00:00"
},
"modified_dateutc": "2026-02-16T15:05:18.1951793+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8c951186-9023-4a02-b20f-61fe27bfbeba",
"date_reported_by_company": "2026-02-16T15:05:18.1951793+00:00",
"id2": 36,
"company_id": "390cad4e-e063-4f3a-b47f-25c441fcf2d1",
"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": "9bd58fc5-f136-407e-be36-ef8b08fdfdd1",
"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-02-16T15:05:18.1951793+00:00"
},
"work_instruction_details_id": "9b48b6dc-ae2f-4470-bf3f-9ae18a8fb672",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fb800973-4fea-4d29-bcf7-ae00a1719e3b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0cae3aa9-08bd-4419-9de8-a5b962128e44",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-16T15:05:18.1951793+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": "ec00aef3-5fdc-429c-b4eb-fb657cac7898",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-16T15:05:18.1951793+00:00"
}