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": "2a81a153-26ed-48d5-a370-3e4fa5be378b",
"jobs_id": "b217f503-6b44-49e9-af3d-603ab143ebeb",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8b9de8cd-8e68-4edd-9188-cc3711c8bcce",
"_parent_id": "016fec5e-3053-4fc1-bf1e-0f92a1d083f0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5f0f50f8-0227-4935-b627-62f3137cde43",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5b3ec78f-daf9-4d25-9be8-c132d4dfd3d7",
"_parent_id": "dc9d4f10-5d15-4228-903b-3dacaf47a69f",
"root_parent_id": "6f3e43c6-90ba-402f-8e6e-856c8fdb2e00",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "870430d9-4e74-4ff0-83dd-cdaacedcb5aa",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3dfdce41-6bb8-45f4-9c41-90563f7e24f5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "645444d4-087c-40a6-b2b0-56416c27aa71",
"_parent_code": "sample string 6",
"sales_organization_id": "ca29b356-4a44-40bd-bba2-0cc9b817c144",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6bc39185-613b-42ee-969c-7963319c4440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aeaff37-fd56-4829-bee8-0a0bcd8cbd2b",
"db_currency_id": "5db2943c-aefb-4247-9fdf-892374fc8991",
"db_language_id": "53f6b4c3-edda-4f9d-967c-a2d3ce700d49",
"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-05-17T19:44:27.8952095+00:00"
},
"modified_dateutc": "2026-05-17T19:44:27.8952095+00:00"
},
"equipment_model_id": "6bd3312a-fad3-43dc-a407-c352640637a0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b966f6da-3bf6-4621-add5-2fa124cd2cfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "133175f5-8436-4aed-b966-9edf01b88dc1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "85df8a59-5c51-4339-b0b8-2bbc85f0dd78",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d423cb04-f03a-4662-92e6-3eda2f6ec423",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6bc39185-613b-42ee-969c-7963319c4440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aeaff37-fd56-4829-bee8-0a0bcd8cbd2b",
"db_currency_id": "5db2943c-aefb-4247-9fdf-892374fc8991",
"db_language_id": "53f6b4c3-edda-4f9d-967c-a2d3ce700d49",
"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-05-17T19:44:27.8952095+00:00"
},
"modified_dateutc": "2026-05-17T19:44:27.8952095+00:00"
},
"equipment_family_id": "4bcf3075-6ac6-4fb2-befa-bd1b2d5ed276",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3dfdce41-6bb8-45f4-9c41-90563f7e24f5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "645444d4-087c-40a6-b2b0-56416c27aa71",
"_parent_code": "sample string 6",
"sales_organization_id": "ca29b356-4a44-40bd-bba2-0cc9b817c144",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6bc39185-613b-42ee-969c-7963319c4440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aeaff37-fd56-4829-bee8-0a0bcd8cbd2b",
"db_currency_id": "5db2943c-aefb-4247-9fdf-892374fc8991",
"db_language_id": "53f6b4c3-edda-4f9d-967c-a2d3ce700d49",
"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-05-17T19:44:27.8952095+00:00"
},
"modified_dateutc": "2026-05-17T19:44:27.8952095+00:00"
},
"date_in_production_since": "2026-05-17T19:44:27.8952095+00:00",
"date_out_of_production_since": "2026-05-17T19:44:27.8952095+00:00",
"date_end_support": "2026-05-17T19:44:27.8952095+00:00",
"sales_organization_id": "ba90bf38-a7ba-4a13-8259-ef1fa2a5a8d3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6bc39185-613b-42ee-969c-7963319c4440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aeaff37-fd56-4829-bee8-0a0bcd8cbd2b",
"db_currency_id": "5db2943c-aefb-4247-9fdf-892374fc8991",
"db_language_id": "53f6b4c3-edda-4f9d-967c-a2d3ce700d49",
"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-05-17T19:44:27.8952095+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-05-17T19:44:27.8952095+00:00"
},
"project_status_id": "c2fbb602-402a-406f-87da-f0e7fed671a0",
"project_status_code": "sample string 10",
"project_status": {
"id": "fcd66541-9caf-42cc-b401-18b3d2d76990",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "58ea0004-82e5-43e6-95d7-04f680c6c036",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6bc39185-613b-42ee-969c-7963319c4440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aeaff37-fd56-4829-bee8-0a0bcd8cbd2b",
"db_currency_id": "5db2943c-aefb-4247-9fdf-892374fc8991",
"db_language_id": "53f6b4c3-edda-4f9d-967c-a2d3ce700d49",
"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-05-17T19:44:27.8952095+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-17T19:44:27.8952095+00:00"
},
"company_id": "f59d4a5f-00ac-4c56-acbd-3b3eef35e003",
"company_code": "sample string 12",
"db_address_id": "8a9cca0e-c688-43af-89f6-9b68e4a4bb63",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9dbaa5cb-7114-44d9-80d6-02e5e5cac419",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "63a485d8-ab64-41d9-888d-270f682fbb23",
"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-05-17T19:44:27.8952095+00:00",
"date_create": "2026-05-17T19:44:27.8952095+00:00",
"date_update": "2026-05-17T19:44:27.8952095+00:00",
"updated_by_user_id": "d163526d-1cb1-45d5-bc0b-5393b5c90777",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-17T19:44:27.8952095+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-05-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-17T19:44:27.8952095+00:00",
"date_last_job": "2026-05-17T19:44:27.8952095+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-17T19:44:27.8952095+00:00",
"modified_dateutc": "2026-05-17T19:44:27.8952095+00:00",
"is_mobile_installation": true
},
"job_type_id": "dd2647d9-bc4a-4a7d-94ee-c88e6f87e593",
"job_type_code": "sample string 7",
"job_type": {
"id": "36df6980-7ed7-4395-8149-0d7814917a2e",
"name": "sample string 2",
"sales_organization_id": "e9e2c532-764d-4f6a-bfed-a38018e62c45",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-17T19:44:27.8952095+00:00",
"code": "sample string 7"
},
"job_priority_id": "b5799184-9146-4c37-9d46-bf09cc2dcd30",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "87386bf4-0f6e-47d8-9eb2-0b5c865300c5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d45145ba-4593-41bc-ac38-7828d6f15801",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6bc39185-613b-42ee-969c-7963319c4440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aeaff37-fd56-4829-bee8-0a0bcd8cbd2b",
"db_currency_id": "5db2943c-aefb-4247-9fdf-892374fc8991",
"db_language_id": "53f6b4c3-edda-4f9d-967c-a2d3ce700d49",
"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-05-17T19:44:27.8952095+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-17T19:44:27.8952095+00:00"
},
"job_status_id": "c2bae0df-6a45-42cc-960d-c409b8d464c3",
"job_status_code": "sample string 11",
"db_address_id": "5ebed9ca-89d2-4224-9761-b1a8bc6a4458",
"contact_id": "8b2034b1-f7a4-436b-96b0-c1cc38e85bc1",
"requested_by_company_id": "d87c8163-a8b4-4cb3-a6d7-b55a5dc9c190",
"requested_by_contact_id": "617d8c98-e000-4eac-8079-3a632a87756a",
"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-05-17T19:44:27.8952095+00:00",
"due_date": "2026-05-17T19:44:27.8952095+00:00",
"date_create": "2026-05-17T19:44:27.8952095+00:00",
"date_update": "2026-05-17T19:44:27.8952095+00:00",
"date_closed": "2026-05-17T19:44:27.8952095+00:00",
"suggested_user_id": "bd9dd249-2a4e-4f81-8b04-05eb91e6c35d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "454e3fcd-dd76-4371-b905-06dc0e000536",
"db_language_id": "f873d375-1f72-44cb-b052-abb5e79fa670",
"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-05-17T19:44:27.8952095+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ad981385-1188-4129-8833-1ab6df55fe84",
"sales_organization": {
"id": "6bc39185-613b-42ee-969c-7963319c4440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aeaff37-fd56-4829-bee8-0a0bcd8cbd2b",
"db_currency_id": "5db2943c-aefb-4247-9fdf-892374fc8991",
"db_language_id": "53f6b4c3-edda-4f9d-967c-a2d3ce700d49",
"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-05-17T19:44:27.8952095+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a09666ad-0bd9-4de6-afe1-862da1c38a61",
"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": "ba28923a-ab44-481b-8aee-8e3d02f6338f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-17T19:44:27.8952095+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7b30b73c-de4b-43da-86a9-e519f827cd88"
},
"suggested_date_start": "2026-05-17T19:44:27.8952095+00:00",
"skill_id": "cca5769a-bb6b-4f89-a7f4-9cee69f9fb7f",
"skill_code": "sample string 32",
"skill": {
"id": "6929c0ee-48e6-4bee-9f6f-4ad3904dcd0b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9212af1c-f7e7-4c3e-be6e-ab2a669f324d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6bc39185-613b-42ee-969c-7963319c4440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aeaff37-fd56-4829-bee8-0a0bcd8cbd2b",
"db_currency_id": "5db2943c-aefb-4247-9fdf-892374fc8991",
"db_language_id": "53f6b4c3-edda-4f9d-967c-a2d3ce700d49",
"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-05-17T19:44:27.8952095+00:00"
},
"modified_dateutc": "2026-05-17T19:44:27.8952095+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e3592be3-0baf-44b7-b4bf-fc2e76b83790",
"date_reported_by_company": "2026-05-17T19:44:27.8952095+00:00",
"id2": 36,
"company_id": "d6d67411-35ae-43ca-8b55-05765c0f636f",
"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": "15fdf571-988b-44aa-a7ec-1248f6abbcb4",
"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-05-17T19:44:27.8952095+00:00"
},
"work_instruction_details_id": "91649dc7-bd5d-43c1-ac2d-85cffef2795b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b0e9bb2e-39f3-406d-835c-3f6b497201f9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4c1690c0-58f7-47a0-a0dd-040fd7c29fd0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-17T19:44:27.8952095+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": "f1cb61a2-346c-4bd1-a1c1-876e5bc89f9b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-17T19:44:27.8952095+00:00"
}