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": "08c7c48d-8e6d-427b-9195-0773be86fc89",
"jobs_id": "fea45592-b87f-483a-9c36-ac8bc1149bb1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "97463c2a-a382-46a1-87bd-c05c795fa489",
"_parent_id": "b27569b4-1a4f-4063-88b0-a33e0b433351",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e2109e27-354d-47b8-83ab-6aa586bfa9eb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d3ca816f-67dd-4262-b1a0-77ca55da5ac6",
"_parent_id": "8ca7215b-b4ab-4a6e-a422-63e9d3afc65f",
"root_parent_id": "7a42d4ad-5e61-4a3e-9568-04c8f818d1e3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7136e1ec-11c7-4a58-8abe-3e5c9e11cc0b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fe1a823b-41b3-409b-a9ba-f5fa25209b6c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3e3ac590-6d28-4211-9e42-567509361519",
"_parent_code": "sample string 6",
"sales_organization_id": "6924cf79-39dc-4162-9df9-816a6fdfcf7d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "37224932-8ef6-4324-a1d9-573bc123e750",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "103160b0-3601-4afc-98b0-46b253e2acb2",
"db_currency_id": "9637799c-9a26-4a80-bc4e-5d11d6da9425",
"db_language_id": "e479ac57-fa2b-46a2-b761-ed9ee1065e25",
"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-09-07T07:30:41.0208979+00:00"
},
"modified_dateutc": "2026-09-07T07:30:41.0208979+00:00"
},
"equipment_model_id": "f060d4fe-b8e3-47e2-8876-b2d6f1c4b93f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "454c5a47-0e20-4a78-a04e-c7193c9ef64d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ed96ea22-f3e3-4844-b437-8e407ed2dc54",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "69b30cc9-33a5-4689-af1b-2dce823f3f35",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7dd75d2a-46f2-49b6-aeb6-908fabbff013",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "37224932-8ef6-4324-a1d9-573bc123e750",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "103160b0-3601-4afc-98b0-46b253e2acb2",
"db_currency_id": "9637799c-9a26-4a80-bc4e-5d11d6da9425",
"db_language_id": "e479ac57-fa2b-46a2-b761-ed9ee1065e25",
"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-09-07T07:30:41.0208979+00:00"
},
"modified_dateutc": "2026-09-07T07:30:41.0208979+00:00"
},
"equipment_family_id": "0ce1c515-79bc-4b20-8ea0-e5f0d7385dd9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fe1a823b-41b3-409b-a9ba-f5fa25209b6c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3e3ac590-6d28-4211-9e42-567509361519",
"_parent_code": "sample string 6",
"sales_organization_id": "6924cf79-39dc-4162-9df9-816a6fdfcf7d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "37224932-8ef6-4324-a1d9-573bc123e750",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "103160b0-3601-4afc-98b0-46b253e2acb2",
"db_currency_id": "9637799c-9a26-4a80-bc4e-5d11d6da9425",
"db_language_id": "e479ac57-fa2b-46a2-b761-ed9ee1065e25",
"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-09-07T07:30:41.0208979+00:00"
},
"modified_dateutc": "2026-09-07T07:30:41.0208979+00:00"
},
"date_in_production_since": "2026-09-07T07:30:41.0208979+00:00",
"date_out_of_production_since": "2026-09-07T07:30:41.0208979+00:00",
"date_end_support": "2026-09-07T07:30:41.0208979+00:00",
"sales_organization_id": "fe43d41d-6d63-422e-9f22-435c3c7abee3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "37224932-8ef6-4324-a1d9-573bc123e750",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "103160b0-3601-4afc-98b0-46b253e2acb2",
"db_currency_id": "9637799c-9a26-4a80-bc4e-5d11d6da9425",
"db_language_id": "e479ac57-fa2b-46a2-b761-ed9ee1065e25",
"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-09-07T07:30:41.0208979+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-09-07T07:30:41.0208979+00:00"
},
"project_status_id": "d5e7f40a-47c9-49c1-b2d8-73f4cef58ef1",
"project_status_code": "sample string 10",
"project_status": {
"id": "90533f73-d254-4193-84c2-b18d17d07db3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0bf51391-4471-4932-a440-780d8c5ec0f7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "37224932-8ef6-4324-a1d9-573bc123e750",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "103160b0-3601-4afc-98b0-46b253e2acb2",
"db_currency_id": "9637799c-9a26-4a80-bc4e-5d11d6da9425",
"db_language_id": "e479ac57-fa2b-46a2-b761-ed9ee1065e25",
"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-09-07T07:30:41.0208979+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-07T07:30:41.0208979+00:00"
},
"company_id": "060ccbd4-027e-4d6d-b1e8-a7164141df55",
"company_code": "sample string 12",
"db_address_id": "893ad1e5-1bc8-48cb-911c-509c5591281f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6fad199c-0c86-4ab4-82c8-09353280adb2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "efd50bb1-3d3e-4e85-a802-dacda90ec2c4",
"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-09-07T07:30:41.0208979+00:00",
"date_create": "2026-09-07T07:30:41.0208979+00:00",
"date_update": "2026-09-07T07:30:41.0208979+00:00",
"updated_by_user_id": "58d1e4af-77aa-4ecd-9f5a-9d2eaee49a3c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-07T07:30:41.0208979+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-09-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-07T07:30:41.0208979+00:00",
"date_last_job": "2026-09-07T07:30:41.0208979+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-07T07:30:41.0208979+00:00",
"modified_dateutc": "2026-09-07T07:30:41.0208979+00:00",
"is_mobile_installation": true
},
"job_type_id": "a4f935e5-da6f-4e47-abdc-bfd7bca70634",
"job_type_code": "sample string 7",
"job_type": {
"id": "9c97775e-d3bf-4bf6-b824-d4137caf2550",
"name": "sample string 2",
"sales_organization_id": "56172c2c-0637-4d11-be64-1c2ad62ef8d6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-07T07:30:41.0208979+00:00",
"code": "sample string 7"
},
"job_priority_id": "a67c1c3d-8b43-41ce-849f-ba03abce46a0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "18bb733f-2dd1-4b4b-9385-a9fbdb389f3c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "62928e34-9b36-4fc4-8ca9-ca5af69c1bd4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "37224932-8ef6-4324-a1d9-573bc123e750",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "103160b0-3601-4afc-98b0-46b253e2acb2",
"db_currency_id": "9637799c-9a26-4a80-bc4e-5d11d6da9425",
"db_language_id": "e479ac57-fa2b-46a2-b761-ed9ee1065e25",
"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-09-07T07:30:41.0208979+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-07T07:30:41.0208979+00:00"
},
"job_status_id": "eee53ce3-d36e-4d4a-9b32-94c1077c8151",
"job_status_code": "sample string 11",
"db_address_id": "965585fc-6054-4671-a6ff-8fbb77ab374f",
"contact_id": "64f0d7ef-a2a9-4589-8f8a-fdc7257e633c",
"requested_by_company_id": "58f4bde5-6c43-4724-b9f1-17c9fd5010cc",
"requested_by_contact_id": "3d55ffce-84af-4bc0-b295-f09258f040e7",
"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-09-07T07:30:41.0208979+00:00",
"due_date": "2026-09-07T07:30:41.0208979+00:00",
"date_create": "2026-09-07T07:30:41.0208979+00:00",
"date_update": "2026-09-07T07:30:41.0208979+00:00",
"date_closed": "2026-09-07T07:30:41.0208979+00:00",
"suggested_user_id": "e9405368-8e90-46a1-a92e-0d032a7c9ccf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8f70439e-8b75-4ccc-9a51-6fbedd216f5b",
"db_language_id": "c22e292c-56c4-4c26-b8fd-fd5ac00a5ad4",
"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-09-07T07:30:41.0208979+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "115d61b7-fdcd-416a-9b4c-65e209c36554",
"sales_organization": {
"id": "37224932-8ef6-4324-a1d9-573bc123e750",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "103160b0-3601-4afc-98b0-46b253e2acb2",
"db_currency_id": "9637799c-9a26-4a80-bc4e-5d11d6da9425",
"db_language_id": "e479ac57-fa2b-46a2-b761-ed9ee1065e25",
"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-09-07T07:30:41.0208979+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e9dfb78b-2fe0-49be-8593-5768cb12f7bc",
"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": "da8ee0ac-c7c8-4d0c-8af8-7db317bee898",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-07T07:30:41.0208979+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "bf980698-02cc-41ed-8e8e-938686d5f460"
},
"suggested_date_start": "2026-09-07T07:30:41.0208979+00:00",
"skill_id": "d96c2800-dd54-4311-963d-ac3736b4a55b",
"skill_code": "sample string 32",
"skill": {
"id": "58b93875-a1af-4407-b182-297b65afec0e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1064facd-b2d4-4944-916b-65098a91be81",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "37224932-8ef6-4324-a1d9-573bc123e750",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "103160b0-3601-4afc-98b0-46b253e2acb2",
"db_currency_id": "9637799c-9a26-4a80-bc4e-5d11d6da9425",
"db_language_id": "e479ac57-fa2b-46a2-b761-ed9ee1065e25",
"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-09-07T07:30:41.0208979+00:00"
},
"modified_dateutc": "2026-09-07T07:30:41.0208979+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1119154d-6e62-437d-ae4d-3eeff1daf930",
"date_reported_by_company": "2026-09-07T07:30:41.0208979+00:00",
"id2": 36,
"company_id": "002dcad4-9da8-41ee-acf5-5c7a4681083d",
"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": "0affab20-7481-4bc9-b3cf-142411a23921",
"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-09-07T07:30:41.0208979+00:00"
},
"work_instruction_details_id": "2ef6c556-720a-468d-a93d-fde9eae055a9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "09ea4f8b-b8a6-4a12-81f8-a83ed32e5061",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cc8cb5d1-7464-4313-99ac-514b0aabeb6b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-07T07:30:41.0208979+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": "4a45861b-11d3-40ec-af41-49612ebbdb08",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-07T07:30:41.0208979+00:00"
}