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": "728f5c4c-e848-4926-ae6d-8e67911ce843",
"jobs_id": "d0b63154-1acf-46d1-a342-a57bf89f5ca3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5f3f8219-bc42-44fc-bdb0-0ce3ce545813",
"_parent_id": "9c1c5b5e-6eee-4751-a1be-5d83930575fc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5ff91d41-7e89-43e1-9be7-6f417ffa0021",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f1188ac4-c9b3-4b6d-9cf5-5171742cf158",
"_parent_id": "bcc3071d-88d9-4400-9be8-b0e6af9d6df7",
"root_parent_id": "dded8e33-8b34-41e7-9300-a72b0af6d1c1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "231792f2-fd14-4091-8dfe-5123d84c6fa8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a33d7b9a-366a-404b-8468-5d78284b1547",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "199ad4fc-6c5e-47ff-a4c3-fdca341daf37",
"_parent_code": "sample string 6",
"sales_organization_id": "ca9a84f7-bd05-436a-bc87-e79e55cc4359",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f550c47a-d964-4711-af38-692a24cae73c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb6c522-54b4-471b-9d28-07ee112216e2",
"db_currency_id": "14984d7e-1f04-49e3-96ab-fb8df900aae7",
"db_language_id": "90856b4c-13e2-4997-90b6-9e11383d74d7",
"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-07-25T06:14:46.4683135+00:00"
},
"modified_dateutc": "2026-07-25T06:14:46.4683135+00:00"
},
"equipment_model_id": "d44fe222-d1b4-400e-bc01-cb1dbeb12a69",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "82d1a476-eea5-4035-86d0-67df8a003e0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8b4f10b5-3800-423e-8426-70a020de2e73",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c67eaa12-d727-4f9f-9cae-22a6e8909602",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "04974ce9-1dc6-4262-b6f3-f54d16a32525",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f550c47a-d964-4711-af38-692a24cae73c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb6c522-54b4-471b-9d28-07ee112216e2",
"db_currency_id": "14984d7e-1f04-49e3-96ab-fb8df900aae7",
"db_language_id": "90856b4c-13e2-4997-90b6-9e11383d74d7",
"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-07-25T06:14:46.4683135+00:00"
},
"modified_dateutc": "2026-07-25T06:14:46.4683135+00:00"
},
"equipment_family_id": "5f4aac1c-10c6-41ad-912a-7e830313e16a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a33d7b9a-366a-404b-8468-5d78284b1547",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "199ad4fc-6c5e-47ff-a4c3-fdca341daf37",
"_parent_code": "sample string 6",
"sales_organization_id": "ca9a84f7-bd05-436a-bc87-e79e55cc4359",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f550c47a-d964-4711-af38-692a24cae73c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb6c522-54b4-471b-9d28-07ee112216e2",
"db_currency_id": "14984d7e-1f04-49e3-96ab-fb8df900aae7",
"db_language_id": "90856b4c-13e2-4997-90b6-9e11383d74d7",
"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-07-25T06:14:46.4683135+00:00"
},
"modified_dateutc": "2026-07-25T06:14:46.4683135+00:00"
},
"date_in_production_since": "2026-07-25T06:14:46.4683135+00:00",
"date_out_of_production_since": "2026-07-25T06:14:46.4683135+00:00",
"date_end_support": "2026-07-25T06:14:46.4683135+00:00",
"sales_organization_id": "b2b26635-73eb-4410-8cf6-4c191f8c1d9d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f550c47a-d964-4711-af38-692a24cae73c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb6c522-54b4-471b-9d28-07ee112216e2",
"db_currency_id": "14984d7e-1f04-49e3-96ab-fb8df900aae7",
"db_language_id": "90856b4c-13e2-4997-90b6-9e11383d74d7",
"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-07-25T06:14:46.4683135+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-07-25T06:14:46.4683135+00:00"
},
"project_status_id": "fe9ff880-a7d4-4fea-a4a2-f5229e0d85ab",
"project_status_code": "sample string 10",
"project_status": {
"id": "d4e1ecce-e082-4b7a-a81d-b8935d27c250",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8f967da5-8f79-4d82-8e64-65a85329115e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f550c47a-d964-4711-af38-692a24cae73c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb6c522-54b4-471b-9d28-07ee112216e2",
"db_currency_id": "14984d7e-1f04-49e3-96ab-fb8df900aae7",
"db_language_id": "90856b4c-13e2-4997-90b6-9e11383d74d7",
"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-07-25T06:14:46.4683135+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-25T06:14:46.4683135+00:00"
},
"company_id": "430378db-7719-474d-a4ad-c5199eed6805",
"company_code": "sample string 12",
"db_address_id": "4667c428-eba8-4079-aebb-7d36a59f3138",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6069baa0-19f0-42e3-9e39-6c98ece8efb5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "71e818c0-4f16-4b1d-a0a7-45a98ae74055",
"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-07-25T06:14:46.4683135+00:00",
"date_create": "2026-07-25T06:14:46.4683135+00:00",
"date_update": "2026-07-25T06:14:46.4683135+00:00",
"updated_by_user_id": "0770d76b-5bfc-4b92-b742-2c934f4059d7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-25T06:14:46.4683135+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-07-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-25T06:14:46.4683135+00:00",
"date_last_job": "2026-07-25T06:14:46.4683135+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-25T06:14:46.4683135+00:00",
"modified_dateutc": "2026-07-25T06:14:46.4683135+00:00",
"is_mobile_installation": true
},
"job_type_id": "945eb7d8-01ef-467a-a08e-fe0a8e40bbd3",
"job_type_code": "sample string 7",
"job_type": {
"id": "20f9f829-f918-4a72-89c0-2c0d979a2e31",
"name": "sample string 2",
"sales_organization_id": "a91d2d0e-5bc0-4405-950d-0cff85eef850",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-25T06:14:46.4683135+00:00",
"code": "sample string 7"
},
"job_priority_id": "d949a727-a7bf-40df-9f6c-95a20f0aae79",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0135d2d5-6625-4991-b199-55f98a9d6dfb",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "88139a58-fe77-4a55-b110-d2ba9b8c212b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f550c47a-d964-4711-af38-692a24cae73c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb6c522-54b4-471b-9d28-07ee112216e2",
"db_currency_id": "14984d7e-1f04-49e3-96ab-fb8df900aae7",
"db_language_id": "90856b4c-13e2-4997-90b6-9e11383d74d7",
"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-07-25T06:14:46.4683135+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-25T06:14:46.4683135+00:00"
},
"job_status_id": "27379de1-6eb0-44b2-bdc1-26e731e5b6b0",
"job_status_code": "sample string 11",
"db_address_id": "538cdb23-d0da-46fc-a74c-6ee2dfa96919",
"contact_id": "97b393ea-0c67-4073-bc50-076a688b2bd1",
"requested_by_company_id": "63800413-543e-48d5-9a67-12e3c586b079",
"requested_by_contact_id": "1e4cedd6-d43a-4db0-8702-d9dd11cbb3b5",
"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-07-25T06:14:46.4683135+00:00",
"due_date": "2026-07-25T06:14:46.4683135+00:00",
"date_create": "2026-07-25T06:14:46.4683135+00:00",
"date_update": "2026-07-25T06:14:46.4683135+00:00",
"date_closed": "2026-07-25T06:14:46.4683135+00:00",
"suggested_user_id": "c6ea726e-a0de-4ab5-9157-f2c4fbb89be2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "604b947f-ffe6-4c99-8736-bfa5c2d60e67",
"db_language_id": "fac73746-2105-47b2-804b-e34969a2b877",
"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-07-25T06:14:46.4683135+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a85c74e0-ec51-46e6-b071-408f867df806",
"sales_organization": {
"id": "f550c47a-d964-4711-af38-692a24cae73c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb6c522-54b4-471b-9d28-07ee112216e2",
"db_currency_id": "14984d7e-1f04-49e3-96ab-fb8df900aae7",
"db_language_id": "90856b4c-13e2-4997-90b6-9e11383d74d7",
"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-07-25T06:14:46.4683135+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a963707d-ae6f-49dd-a50c-4301e668941a",
"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": "d5cfb8ef-b491-47b5-86dd-967a54374d8c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-25T06:14:46.4683135+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "50361bf9-c7df-42e6-b868-68f49bea6b00"
},
"suggested_date_start": "2026-07-25T06:14:46.4683135+00:00",
"skill_id": "cac9389d-a292-4c5c-98a9-84f023b14dce",
"skill_code": "sample string 32",
"skill": {
"id": "ecbbf397-3a31-4719-9138-139e06b222c4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e7dd03fc-d7e4-4e1b-9e57-df7447f88d6e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f550c47a-d964-4711-af38-692a24cae73c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb6c522-54b4-471b-9d28-07ee112216e2",
"db_currency_id": "14984d7e-1f04-49e3-96ab-fb8df900aae7",
"db_language_id": "90856b4c-13e2-4997-90b6-9e11383d74d7",
"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-07-25T06:14:46.4683135+00:00"
},
"modified_dateutc": "2026-07-25T06:14:46.4683135+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "283838be-8bb3-42a0-88f6-19c4c9f5f647",
"date_reported_by_company": "2026-07-25T06:14:46.4683135+00:00",
"id2": 36,
"company_id": "d04f16c6-a2d0-4b68-9f45-8fa612793ae6",
"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": "26ae067f-d061-4d6f-8b38-c7660a9efc61",
"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-07-25T06:14:46.4683135+00:00"
},
"work_instruction_details_id": "f3bc76aa-7cb1-4b55-b5d6-1af1376b3b74",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "33c64272-0d41-4cf7-a7d7-d263c418539c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "01b26369-9001-47fa-9bfa-b4482325c819",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-25T06:14:46.4683135+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": "402d5dd2-b52a-4654-82f7-8c6c39bad6dd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-25T06:14:46.4683135+00:00"
}