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": "d5aa6b10-23ea-4fd2-ade8-423e0563789b",
"jobs_id": "29e6bd69-a109-48ac-81db-03850531ac2a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4d675b86-4611-4b0e-9d6c-8c553aa9a422",
"_parent_id": "786c3a57-6d86-48b6-8017-3ff2a1f4c2a8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4853f18c-f9fb-4016-badd-46d62dba886c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "adee170c-65e8-485f-b3bf-46bc7f5f4d30",
"_parent_id": "a7bc2099-2e7b-492f-9022-0abd3ba30e68",
"root_parent_id": "f1dfa32f-3aef-4dc5-b727-0635f99e6343",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d07f9962-b83b-46ef-b98e-41ccfeb86aff",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9e315c13-8b68-497a-81b3-90732d692086",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "10560f1e-4746-4994-825f-807b3a70fc6f",
"_parent_code": "sample string 6",
"sales_organization_id": "78493938-5902-4938-a7e9-65c962205301",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "78df2308-8500-4376-9180-31bb907afb2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7660a7d-0390-47a4-a4d1-43c206298fce",
"db_currency_id": "c2bf39a4-5976-46e8-8ce8-d3f9df3c2cdb",
"db_language_id": "3bc64bea-6e11-493c-982e-a7f552720eb1",
"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-08-03T06:45:18.5167557+00:00"
},
"modified_dateutc": "2026-08-03T06:45:18.5167557+00:00"
},
"equipment_model_id": "14039397-5a89-4def-ab81-fbba51061408",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "42f82c94-87e9-49d3-90fe-ec466fe8a5bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "49e056e2-258d-46ce-ba3f-6c4f38b857ab",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2781b31e-1dd5-45de-ba2d-b5c9da8e2276",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0bf5346a-f593-4d50-9c40-56c4b08e7e19",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "78df2308-8500-4376-9180-31bb907afb2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7660a7d-0390-47a4-a4d1-43c206298fce",
"db_currency_id": "c2bf39a4-5976-46e8-8ce8-d3f9df3c2cdb",
"db_language_id": "3bc64bea-6e11-493c-982e-a7f552720eb1",
"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-08-03T06:45:18.5167557+00:00"
},
"modified_dateutc": "2026-08-03T06:45:18.5167557+00:00"
},
"equipment_family_id": "174a4d39-2803-4295-8ae7-14eef401a019",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9e315c13-8b68-497a-81b3-90732d692086",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "10560f1e-4746-4994-825f-807b3a70fc6f",
"_parent_code": "sample string 6",
"sales_organization_id": "78493938-5902-4938-a7e9-65c962205301",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "78df2308-8500-4376-9180-31bb907afb2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7660a7d-0390-47a4-a4d1-43c206298fce",
"db_currency_id": "c2bf39a4-5976-46e8-8ce8-d3f9df3c2cdb",
"db_language_id": "3bc64bea-6e11-493c-982e-a7f552720eb1",
"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-08-03T06:45:18.5167557+00:00"
},
"modified_dateutc": "2026-08-03T06:45:18.5167557+00:00"
},
"date_in_production_since": "2026-08-03T06:45:18.5167557+00:00",
"date_out_of_production_since": "2026-08-03T06:45:18.5167557+00:00",
"date_end_support": "2026-08-03T06:45:18.5167557+00:00",
"sales_organization_id": "f2acbe86-bc1e-4e7e-8241-255f66377eb4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "78df2308-8500-4376-9180-31bb907afb2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7660a7d-0390-47a4-a4d1-43c206298fce",
"db_currency_id": "c2bf39a4-5976-46e8-8ce8-d3f9df3c2cdb",
"db_language_id": "3bc64bea-6e11-493c-982e-a7f552720eb1",
"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-08-03T06:45:18.5167557+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-08-03T06:45:18.5167557+00:00"
},
"project_status_id": "f79ff4e3-bf4b-4ff5-88b8-ad8085a9ef97",
"project_status_code": "sample string 10",
"project_status": {
"id": "d708f398-eb2e-45d4-8513-85a2a77f8528",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4e20253b-ea14-4443-ba1f-08ce13374766",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "78df2308-8500-4376-9180-31bb907afb2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7660a7d-0390-47a4-a4d1-43c206298fce",
"db_currency_id": "c2bf39a4-5976-46e8-8ce8-d3f9df3c2cdb",
"db_language_id": "3bc64bea-6e11-493c-982e-a7f552720eb1",
"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-08-03T06:45:18.5167557+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-03T06:45:18.5167557+00:00"
},
"company_id": "a3124cc4-aa58-4b1c-8776-5d7d0169f70d",
"company_code": "sample string 12",
"db_address_id": "99d16f60-2540-423d-a9ff-81936a0bf7d4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0f9168b9-5b6c-4a51-b083-24f0e3fb2f67",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cca4ff21-094a-4428-8ab4-f2d4c87137f6",
"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-08-03T06:45:18.5167557+00:00",
"date_create": "2026-08-03T06:45:18.5167557+00:00",
"date_update": "2026-08-03T06:45:18.5167557+00:00",
"updated_by_user_id": "ab96ee53-63fd-445c-ab81-9129450b77b5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-03T06:45:18.5167557+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-08-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-03T06:45:18.5167557+00:00",
"date_last_job": "2026-08-03T06:45:18.5167557+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-03T06:45:18.5167557+00:00",
"modified_dateutc": "2026-08-03T06:45:18.5167557+00:00",
"is_mobile_installation": true
},
"job_type_id": "d355812b-dc83-4793-b47c-b061ddfa61af",
"job_type_code": "sample string 7",
"job_type": {
"id": "6ca8d6a7-7c56-4215-86fe-184be9689cd0",
"name": "sample string 2",
"sales_organization_id": "66fa2221-9474-4856-9bbc-ab94c76355d7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-03T06:45:18.5167557+00:00",
"code": "sample string 7"
},
"job_priority_id": "547f7368-74b4-481f-9a93-1c87a12ddbac",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6911289d-397d-42f7-81d8-4a52710729f7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1f70d701-214a-485b-aa7c-2b8d1f787aaa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "78df2308-8500-4376-9180-31bb907afb2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7660a7d-0390-47a4-a4d1-43c206298fce",
"db_currency_id": "c2bf39a4-5976-46e8-8ce8-d3f9df3c2cdb",
"db_language_id": "3bc64bea-6e11-493c-982e-a7f552720eb1",
"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-08-03T06:45:18.5167557+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-03T06:45:18.5167557+00:00"
},
"job_status_id": "a3ebf6fb-1721-46f4-9f2a-f730f27ed5cf",
"job_status_code": "sample string 11",
"db_address_id": "470b8916-8896-42a8-b9b7-9cdf1dfe21ef",
"contact_id": "f68d6d3d-168c-44fe-8d3b-f562e0daad23",
"requested_by_company_id": "1013e099-5b5e-4ead-8fd9-3fad5dde661a",
"requested_by_contact_id": "778de2d9-3dd4-4113-8f22-9e07726d49f2",
"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-08-03T06:45:18.5167557+00:00",
"due_date": "2026-08-03T06:45:18.5167557+00:00",
"date_create": "2026-08-03T06:45:18.5167557+00:00",
"date_update": "2026-08-03T06:45:18.5167557+00:00",
"date_closed": "2026-08-03T06:45:18.5167557+00:00",
"suggested_user_id": "16c4031b-8617-4c4d-ab6c-25d514d15c6b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "88e48666-9ef9-492a-9536-d981d5a7ee3b",
"db_language_id": "dab9c093-8cdb-4fd3-b6de-b1b7180447c8",
"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-08-03T06:45:18.5167557+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5242e5e6-3ddd-4989-8ed6-8ba99f975476",
"sales_organization": {
"id": "78df2308-8500-4376-9180-31bb907afb2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7660a7d-0390-47a4-a4d1-43c206298fce",
"db_currency_id": "c2bf39a4-5976-46e8-8ce8-d3f9df3c2cdb",
"db_language_id": "3bc64bea-6e11-493c-982e-a7f552720eb1",
"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-08-03T06:45:18.5167557+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0af8f080-8fb7-42ab-abb6-3735593aa14a",
"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": "d4485716-c169-4565-be2e-f3bb4ab18a8e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-03T06:45:18.5167557+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "901a4412-8a9c-481a-9991-70401c7bd359"
},
"suggested_date_start": "2026-08-03T06:45:18.5167557+00:00",
"skill_id": "4f2b1e5b-4330-497e-a492-7110795a90af",
"skill_code": "sample string 32",
"skill": {
"id": "8e22b72d-7ea8-4672-abc4-033d0b4ad42a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6c7200bf-d945-480a-b368-652bbf6cbd9a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "78df2308-8500-4376-9180-31bb907afb2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7660a7d-0390-47a4-a4d1-43c206298fce",
"db_currency_id": "c2bf39a4-5976-46e8-8ce8-d3f9df3c2cdb",
"db_language_id": "3bc64bea-6e11-493c-982e-a7f552720eb1",
"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-08-03T06:45:18.5167557+00:00"
},
"modified_dateutc": "2026-08-03T06:45:18.5167557+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a68c0819-b2db-4273-bd78-c902ddd6bca9",
"date_reported_by_company": "2026-08-03T06:45:18.5167557+00:00",
"id2": 36,
"company_id": "4e14157c-5fa9-4070-a1ae-036bdf92d882",
"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": "e504291b-316e-46bb-82ae-7da1bea141ab",
"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-08-03T06:45:18.5167557+00:00"
},
"work_instruction_details_id": "dcce376d-387c-4dde-8295-2368c30d3bf1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f7e13a37-fdd9-407c-acc3-a489986db85c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "18a057da-9a49-47ce-b94e-1e43bde6f60e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-03T06:45:18.5167557+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": "67af5321-3490-483b-9a3a-067d58b3f8f5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-03T06:45:18.5167557+00:00"
}