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": "78d204f0-287f-4c36-95e7-ad7f573e4e41",
"jobs_id": "8fa2cdea-e076-4095-b330-9d54de1879b4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ff210a27-5ab9-41bc-897d-b4cdd7842ac6",
"_parent_id": "aa723547-8cd2-4c48-8be4-16f1bfa3dccd",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c3abff92-ff9f-40e2-ba6c-7932fcd7f6d4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c3aea4c6-4c5b-4104-9be5-309e43b925dd",
"_parent_id": "8249ce6a-b1a4-4496-af92-e4c93a9b1104",
"root_parent_id": "a88a2ad8-d81c-4fa4-a1e7-bf2556e880d2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "31dc8262-8ac5-48a8-9189-9117fb61b3dd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3e6cc3d2-8a8e-480f-adab-dc0235094951",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "483765a0-1797-42eb-8f48-90cec8235ba4",
"_parent_code": "sample string 6",
"sales_organization_id": "c1415f27-57d5-45ad-8471-5f7043031727",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c2ca0a5b-f2ff-4cba-80f2-1fdb62969238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a22b039b-396d-42eb-8d66-1ebae31ce104",
"db_currency_id": "3adc7d87-a2a9-4970-92d3-132def0f9574",
"db_language_id": "65acd101-d005-4b47-b6f6-9a0c7096c44e",
"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": "2025-11-08T21:19:15.1564471+00:00"
},
"modified_dateutc": "2025-11-08T21:19:15.1564471+00:00"
},
"equipment_model_id": "7c6e0c9c-df97-4e22-aee0-37d6d4c63ae2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3fcbbaf9-20c6-4bc0-b9b1-d4fccee73e84",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "740d26bc-dcdc-479e-89d8-9a79829d79a3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f84ae5ee-79cc-49ae-b4f0-b24514037894",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "359fb4b4-2fe4-4e21-9c3e-87e40b207345",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c2ca0a5b-f2ff-4cba-80f2-1fdb62969238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a22b039b-396d-42eb-8d66-1ebae31ce104",
"db_currency_id": "3adc7d87-a2a9-4970-92d3-132def0f9574",
"db_language_id": "65acd101-d005-4b47-b6f6-9a0c7096c44e",
"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": "2025-11-08T21:19:15.1564471+00:00"
},
"modified_dateutc": "2025-11-08T21:19:15.1564471+00:00"
},
"equipment_family_id": "75772caf-ae9b-45b2-a584-3d1d95c720eb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3e6cc3d2-8a8e-480f-adab-dc0235094951",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "483765a0-1797-42eb-8f48-90cec8235ba4",
"_parent_code": "sample string 6",
"sales_organization_id": "c1415f27-57d5-45ad-8471-5f7043031727",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c2ca0a5b-f2ff-4cba-80f2-1fdb62969238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a22b039b-396d-42eb-8d66-1ebae31ce104",
"db_currency_id": "3adc7d87-a2a9-4970-92d3-132def0f9574",
"db_language_id": "65acd101-d005-4b47-b6f6-9a0c7096c44e",
"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": "2025-11-08T21:19:15.1564471+00:00"
},
"modified_dateutc": "2025-11-08T21:19:15.1564471+00:00"
},
"date_in_production_since": "2025-11-08T21:19:15.1564471+00:00",
"date_out_of_production_since": "2025-11-08T21:19:15.1564471+00:00",
"date_end_support": "2025-11-08T21:19:15.1564471+00:00",
"sales_organization_id": "56a0a0af-8d79-4820-b727-7da04a06131a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c2ca0a5b-f2ff-4cba-80f2-1fdb62969238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a22b039b-396d-42eb-8d66-1ebae31ce104",
"db_currency_id": "3adc7d87-a2a9-4970-92d3-132def0f9574",
"db_language_id": "65acd101-d005-4b47-b6f6-9a0c7096c44e",
"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": "2025-11-08T21:19:15.1564471+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": "2025-11-08T21:19:15.1564471+00:00"
},
"project_status_id": "f636e7b3-d23a-426a-b93f-aa75d5e06548",
"project_status_code": "sample string 10",
"project_status": {
"id": "08c74385-0fd2-402e-93df-e40e333aac0e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4086eee7-7f43-4301-8d64-d3bfc830de5a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c2ca0a5b-f2ff-4cba-80f2-1fdb62969238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a22b039b-396d-42eb-8d66-1ebae31ce104",
"db_currency_id": "3adc7d87-a2a9-4970-92d3-132def0f9574",
"db_language_id": "65acd101-d005-4b47-b6f6-9a0c7096c44e",
"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": "2025-11-08T21:19:15.1564471+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-08T21:19:15.1564471+00:00"
},
"company_id": "8a11d806-ac3c-48f0-932e-b0cf54977dc3",
"company_code": "sample string 12",
"db_address_id": "f7966aa2-9633-4c1c-b5fd-e8c62f75b086",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cbf639e1-a413-43e3-a15f-ef13da040198",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "20b9b0b1-b4ee-404b-b38d-726a48d592bd",
"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": "2025-11-08T21:19:15.1564471+00:00",
"date_create": "2025-11-08T21:19:15.1564471+00:00",
"date_update": "2025-11-08T21:19:15.1564471+00:00",
"updated_by_user_id": "e6442dbe-8345-47e3-99a6-c8cc19e0c342",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-08T21:19:15.1564471+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": "2025-11-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-08T21:19:15.1564471+00:00",
"date_last_job": "2025-11-08T21:19:15.1564471+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-08T21:19:15.1564471+00:00",
"modified_dateutc": "2025-11-08T21:19:15.1564471+00:00",
"is_mobile_installation": true
},
"job_type_id": "f050386c-bc18-4c06-bca1-2b66fdd621f9",
"job_type_code": "sample string 7",
"job_type": {
"id": "de89c4e5-f036-40f5-81ae-98dcfb636d36",
"name": "sample string 2",
"sales_organization_id": "c6739a56-6297-488c-9105-18e8d6fcdf5a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-08T21:19:15.1564471+00:00",
"code": "sample string 7"
},
"job_priority_id": "b4b079cf-594b-4c14-ba2c-599bebd7fb26",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ca821173-8d68-4e25-9c4b-5d0592e0bb1d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d37e83f3-9eeb-4299-b100-bf725727414d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c2ca0a5b-f2ff-4cba-80f2-1fdb62969238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a22b039b-396d-42eb-8d66-1ebae31ce104",
"db_currency_id": "3adc7d87-a2a9-4970-92d3-132def0f9574",
"db_language_id": "65acd101-d005-4b47-b6f6-9a0c7096c44e",
"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": "2025-11-08T21:19:15.1564471+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-08T21:19:15.1564471+00:00"
},
"job_status_id": "43d7a4b8-59ee-43b2-88d9-4bd30105ceaf",
"job_status_code": "sample string 11",
"db_address_id": "2a87bc7e-8857-4ae2-a7e8-7eac9003a437",
"contact_id": "279dff73-8c28-47ef-a0ea-399ee7b20412",
"requested_by_company_id": "cee9e907-e0c0-4eb8-beea-29fb36b7d826",
"requested_by_contact_id": "2ac5e502-febf-41a4-9603-ffce471f2041",
"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": "2025-11-08T21:19:15.1564471+00:00",
"due_date": "2025-11-08T21:19:15.1564471+00:00",
"date_create": "2025-11-08T21:19:15.1564471+00:00",
"date_update": "2025-11-08T21:19:15.1564471+00:00",
"date_closed": "2025-11-08T21:19:15.1564471+00:00",
"suggested_user_id": "6b132122-7e25-4634-bdb6-dab2d0e4e945",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ad0b5637-bc34-4038-bc8c-ddc6c82c0c52",
"db_language_id": "b7e225b5-a0f4-46ea-8dcc-2e5c13ad8119",
"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": "2025-11-08T21:19:15.1564471+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3cfd207c-b97e-4116-ae44-2ac38097e06a",
"sales_organization": {
"id": "c2ca0a5b-f2ff-4cba-80f2-1fdb62969238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a22b039b-396d-42eb-8d66-1ebae31ce104",
"db_currency_id": "3adc7d87-a2a9-4970-92d3-132def0f9574",
"db_language_id": "65acd101-d005-4b47-b6f6-9a0c7096c44e",
"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": "2025-11-08T21:19:15.1564471+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8485cf2c-2969-4f3e-b573-1088a6c83016",
"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": "c157d7aa-0439-478e-9d68-a9eddab52631",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-08T21:19:15.1564471+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "856ac636-ef6a-4578-8890-9061c8ba0fdd"
},
"suggested_date_start": "2025-11-08T21:19:15.1564471+00:00",
"skill_id": "11c8f9f3-b042-4164-beb3-eb8b9df0269d",
"skill_code": "sample string 32",
"skill": {
"id": "19cb4fba-f23e-45aa-bf79-00449a64b4ca",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5540a023-6429-44cb-b62c-9ac441b93fc7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c2ca0a5b-f2ff-4cba-80f2-1fdb62969238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a22b039b-396d-42eb-8d66-1ebae31ce104",
"db_currency_id": "3adc7d87-a2a9-4970-92d3-132def0f9574",
"db_language_id": "65acd101-d005-4b47-b6f6-9a0c7096c44e",
"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": "2025-11-08T21:19:15.1564471+00:00"
},
"modified_dateutc": "2025-11-08T21:19:15.1564471+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f22dd07f-a4f1-43ac-815a-e6d594da98cc",
"date_reported_by_company": "2025-11-08T21:19:15.1564471+00:00",
"id2": 36,
"company_id": "7a460782-8425-4384-820b-b0838c77e9b7",
"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": "fd844704-fe34-4699-ba65-dc9efa12b132",
"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": "2025-11-08T21:19:15.1564471+00:00"
},
"work_instruction_details_id": "8eac132f-053f-49f6-ab9c-09f9c1a04ea6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6e87a0bf-d203-4390-b385-d1ba6d3098de",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ca7ed80f-7b7c-4892-a9c5-3f262a8a6e70",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-08T21:19:15.1564471+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": "7ecfab8a-7938-40b9-9f39-7ab60fd64f83",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-08T21:19:15.1564471+00:00"
}