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": "0e2f53e7-b9ba-40c8-826a-31afb4453331",
"jobs_id": "9ea1fd2e-61fc-43b8-bab7-2db98aef5bdb",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8d57cda7-49a6-46dd-9c60-95540f0800f4",
"_parent_id": "2ddc2008-509e-4b67-a6d7-115d0271fa5e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "91aa0171-5eaa-45f0-b09e-3db76ffe8c73",
"project_reference_back_office": "sample string 5",
"project": {
"id": "25c4da5f-6ec9-4314-bea3-93b47adc1622",
"_parent_id": "bbadaa84-513a-452d-81ef-3a8174a33c7a",
"root_parent_id": "71d0ba4f-67bc-444b-87b0-3f8dc453f274",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3d21b0ab-89fc-4eb0-a8a6-418c05808a39",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "626d8527-70fe-4d56-ab6a-c61984141eb1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fafccf5a-05d6-4e43-ab2c-bef7fbae4dfe",
"_parent_code": "sample string 6",
"sales_organization_id": "e9a01871-3dab-4a48-9972-b6d1600707f8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bfb238da-8b8e-4008-bd9e-995f7c6d0532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88ca1753-9271-4c95-8657-701f853df7cc",
"db_currency_id": "f7ed0e9c-e7bd-4c43-99ad-218206cd9aec",
"db_language_id": "cdab336d-01cb-4047-a413-6b0b7de9e4a3",
"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-30T17:18:16.7316526+00:00"
},
"modified_dateutc": "2026-01-30T17:18:16.7316526+00:00"
},
"equipment_model_id": "629c4f62-e00c-4233-88b4-f236207d4ee3",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "affeaa34-84a2-4996-9baa-f07d1f0c8e0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d6ba296f-70cf-4171-a9c9-fb588dfe150d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "eb4277c1-3ca5-4166-9316-8c343b552bc8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "29e0104f-8ea0-4ac9-bcdf-fe5e2f7bf114",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bfb238da-8b8e-4008-bd9e-995f7c6d0532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88ca1753-9271-4c95-8657-701f853df7cc",
"db_currency_id": "f7ed0e9c-e7bd-4c43-99ad-218206cd9aec",
"db_language_id": "cdab336d-01cb-4047-a413-6b0b7de9e4a3",
"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-30T17:18:16.7316526+00:00"
},
"modified_dateutc": "2026-01-30T17:18:16.7316526+00:00"
},
"equipment_family_id": "b63cf971-1f4d-4424-bbc2-032f5147fb60",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "626d8527-70fe-4d56-ab6a-c61984141eb1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fafccf5a-05d6-4e43-ab2c-bef7fbae4dfe",
"_parent_code": "sample string 6",
"sales_organization_id": "e9a01871-3dab-4a48-9972-b6d1600707f8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bfb238da-8b8e-4008-bd9e-995f7c6d0532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88ca1753-9271-4c95-8657-701f853df7cc",
"db_currency_id": "f7ed0e9c-e7bd-4c43-99ad-218206cd9aec",
"db_language_id": "cdab336d-01cb-4047-a413-6b0b7de9e4a3",
"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-30T17:18:16.7316526+00:00"
},
"modified_dateutc": "2026-01-30T17:18:16.7316526+00:00"
},
"date_in_production_since": "2026-01-30T17:18:16.7316526+00:00",
"date_out_of_production_since": "2026-01-30T17:18:16.7316526+00:00",
"date_end_support": "2026-01-30T17:18:16.7316526+00:00",
"sales_organization_id": "64743aa4-0399-4bd9-9b24-99abfe05400d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bfb238da-8b8e-4008-bd9e-995f7c6d0532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88ca1753-9271-4c95-8657-701f853df7cc",
"db_currency_id": "f7ed0e9c-e7bd-4c43-99ad-218206cd9aec",
"db_language_id": "cdab336d-01cb-4047-a413-6b0b7de9e4a3",
"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-30T17:18:16.7316526+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-30T17:18:16.7316526+00:00"
},
"project_status_id": "6ff727ca-7562-4de8-bdd9-8773b91b184b",
"project_status_code": "sample string 10",
"project_status": {
"id": "358ef83d-e7ed-44b2-b500-6787586b37a6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d8c41894-bb7e-4330-b3aa-1100ae4f09a9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bfb238da-8b8e-4008-bd9e-995f7c6d0532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88ca1753-9271-4c95-8657-701f853df7cc",
"db_currency_id": "f7ed0e9c-e7bd-4c43-99ad-218206cd9aec",
"db_language_id": "cdab336d-01cb-4047-a413-6b0b7de9e4a3",
"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-30T17:18:16.7316526+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-30T17:18:16.7316526+00:00"
},
"company_id": "0d0b566a-49b2-48a6-95a0-2a0919ce52b2",
"company_code": "sample string 12",
"db_address_id": "f05d4564-03e2-481b-82b1-b6ef738263ea",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1605049e-c299-4605-89c9-2d27c85d2a14",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "15c876fe-cb09-424e-b947-f6c8d754d772",
"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-30T17:18:16.7316526+00:00",
"date_create": "2026-01-30T17:18:16.7316526+00:00",
"date_update": "2026-01-30T17:18:16.7316526+00:00",
"updated_by_user_id": "85978135-8d83-4c81-b665-e841896fa34a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-30T17:18:16.7316526+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-30T17:18:16.7316526+00:00",
"date_last_job": "2026-01-30T17:18:16.7316526+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-30T17:18:16.7316526+00:00",
"modified_dateutc": "2026-01-30T17:18:16.7316526+00:00",
"is_mobile_installation": true
},
"job_type_id": "04222a04-2496-4176-b9ba-901c44a8462a",
"job_type_code": "sample string 7",
"job_type": {
"id": "f831f0e5-26f5-4095-8396-c8d7536fb084",
"name": "sample string 2",
"sales_organization_id": "aa7b9ad7-18ac-4078-bd9e-cd410b0fe934",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-30T17:18:16.7316526+00:00",
"code": "sample string 7"
},
"job_priority_id": "3e6c6e3e-de0f-4abb-9fe1-2f2317ad4177",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "01e5c3c2-b5df-4092-ab04-5d9048bff1b1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "528d816f-4d48-4197-a8be-780ee701516a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bfb238da-8b8e-4008-bd9e-995f7c6d0532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88ca1753-9271-4c95-8657-701f853df7cc",
"db_currency_id": "f7ed0e9c-e7bd-4c43-99ad-218206cd9aec",
"db_language_id": "cdab336d-01cb-4047-a413-6b0b7de9e4a3",
"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-30T17:18:16.7316526+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-30T17:18:16.7316526+00:00"
},
"job_status_id": "40d4af03-8a8b-45bc-90ff-6cdc68e7a75d",
"job_status_code": "sample string 11",
"db_address_id": "b581c8c9-1749-4ab6-8464-d18a67a5be3d",
"contact_id": "683d9248-1066-4a38-83d1-d82cf8d14a5c",
"requested_by_company_id": "742d4be1-b3b9-442c-883c-6bf267c5cfde",
"requested_by_contact_id": "db09493c-2b4d-4920-af17-6431f18febc3",
"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-30T17:18:16.7316526+00:00",
"due_date": "2026-01-30T17:18:16.7316526+00:00",
"date_create": "2026-01-30T17:18:16.7316526+00:00",
"date_update": "2026-01-30T17:18:16.7316526+00:00",
"date_closed": "2026-01-30T17:18:16.7316526+00:00",
"suggested_user_id": "0ac6635e-87dc-497e-8ed9-9dee48aba468",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7d1c279a-341a-4b0f-8ab6-1b1bc833fcd7",
"db_language_id": "f5186ff6-feed-4b70-9479-71eae51d3c21",
"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-30T17:18:16.7316526+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8f1368ec-c398-43ba-8474-c14e476673ab",
"sales_organization": {
"id": "bfb238da-8b8e-4008-bd9e-995f7c6d0532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88ca1753-9271-4c95-8657-701f853df7cc",
"db_currency_id": "f7ed0e9c-e7bd-4c43-99ad-218206cd9aec",
"db_language_id": "cdab336d-01cb-4047-a413-6b0b7de9e4a3",
"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-30T17:18:16.7316526+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1c18fc9f-4460-4a08-aba4-0adbbdf9895c",
"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": "f2a9c7e4-bc53-4914-9d56-a970fbb82fd2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-30T17:18:16.7316526+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2495f57b-617c-44b4-9803-c489692ee203"
},
"suggested_date_start": "2026-01-30T17:18:16.7316526+00:00",
"skill_id": "39616f06-0281-4de6-b887-ff3163307a78",
"skill_code": "sample string 32",
"skill": {
"id": "343e84c7-9f96-4ecf-ae5b-417ffc48c349",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "01bcd9ee-f645-4cdd-995e-68350f332840",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bfb238da-8b8e-4008-bd9e-995f7c6d0532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88ca1753-9271-4c95-8657-701f853df7cc",
"db_currency_id": "f7ed0e9c-e7bd-4c43-99ad-218206cd9aec",
"db_language_id": "cdab336d-01cb-4047-a413-6b0b7de9e4a3",
"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-30T17:18:16.7316526+00:00"
},
"modified_dateutc": "2026-01-30T17:18:16.7316526+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ce261179-0bc4-4add-904d-caff01a1ab59",
"date_reported_by_company": "2026-01-30T17:18:16.7316526+00:00",
"id2": 36,
"company_id": "cf823bc3-f637-41a8-a80d-429d8e148f16",
"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": "2de29416-e475-4681-9177-b485f3236e76",
"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-30T17:18:16.7316526+00:00"
},
"work_instruction_details_id": "87d46209-feb3-4a08-8112-32369ae105b8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d77e8030-4ba8-4fe0-9516-af410ba24202",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f44b27ad-b01e-4498-93b1-17488686c011",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-30T17:18:16.7316526+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": "cbf9eca2-5330-4aa8-b6b4-bd2d48f05c59",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-30T17:18:16.7316526+00:00"
}