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": "89192835-54f7-45ab-af15-56d5750e326f",
"jobs_id": "24de2323-5b26-48fd-93ce-2f4da8cd75e4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "49d8b7f9-6a98-4f65-9b87-b9c7129244d8",
"_parent_id": "975de06b-ca3e-43c8-8dc2-b1f806809e68",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "94af7cc9-8937-44d1-8c77-6ef739a88d51",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1b69922b-3c57-4975-8bb7-51fe022bd0a6",
"_parent_id": "535c5c34-2941-4629-b73d-46e2b71c4532",
"root_parent_id": "a7896738-0423-45af-84b2-9572696d78b9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "76e4061e-7ec3-4c51-8399-7b82d9cd1ceb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d779a05e-8f68-4b66-a081-cc160734993b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2c112e4a-708e-44a7-96d5-f859d5fded0d",
"_parent_code": "sample string 6",
"sales_organization_id": "1c24290f-8f5d-43c9-9898-900467a248e7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8356678d-263a-488e-8929-6a48459e5765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d2dfd71-3faf-42e3-8d9e-a6a4d3a09139",
"db_currency_id": "c125e132-5a3e-4407-8b4d-e13e75172b6e",
"db_language_id": "55b267d7-c052-45f7-bf8e-bec4811375ac",
"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-11-07T11:38:55.4655386+00:00"
},
"modified_dateutc": "2026-11-07T11:38:55.4655386+00:00"
},
"equipment_model_id": "d83ac98e-6b28-4e66-9fde-5af900640d20",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0d97bf6a-75da-4d83-8245-8f926d9440af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "958d09d6-cb2c-4362-9d97-e9098871a4f0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "49da0be8-d44d-4c5a-b9b5-00863ed3c7e5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4a3234f4-88ef-490e-828e-440fb520088c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8356678d-263a-488e-8929-6a48459e5765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d2dfd71-3faf-42e3-8d9e-a6a4d3a09139",
"db_currency_id": "c125e132-5a3e-4407-8b4d-e13e75172b6e",
"db_language_id": "55b267d7-c052-45f7-bf8e-bec4811375ac",
"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-11-07T11:38:55.4655386+00:00"
},
"modified_dateutc": "2026-11-07T11:38:55.4655386+00:00"
},
"equipment_family_id": "09c5079d-c2cb-4f6a-9c2e-e47bfb538bce",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d779a05e-8f68-4b66-a081-cc160734993b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2c112e4a-708e-44a7-96d5-f859d5fded0d",
"_parent_code": "sample string 6",
"sales_organization_id": "1c24290f-8f5d-43c9-9898-900467a248e7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8356678d-263a-488e-8929-6a48459e5765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d2dfd71-3faf-42e3-8d9e-a6a4d3a09139",
"db_currency_id": "c125e132-5a3e-4407-8b4d-e13e75172b6e",
"db_language_id": "55b267d7-c052-45f7-bf8e-bec4811375ac",
"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-11-07T11:38:55.4655386+00:00"
},
"modified_dateutc": "2026-11-07T11:38:55.4655386+00:00"
},
"date_in_production_since": "2026-11-07T11:38:55.4655386+00:00",
"date_out_of_production_since": "2026-11-07T11:38:55.4655386+00:00",
"date_end_support": "2026-11-07T11:38:55.4655386+00:00",
"sales_organization_id": "ad2163bb-50a6-434b-b15a-f519787bb589",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8356678d-263a-488e-8929-6a48459e5765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d2dfd71-3faf-42e3-8d9e-a6a4d3a09139",
"db_currency_id": "c125e132-5a3e-4407-8b4d-e13e75172b6e",
"db_language_id": "55b267d7-c052-45f7-bf8e-bec4811375ac",
"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-11-07T11:38:55.4655386+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-11-07T11:38:55.4655386+00:00"
},
"project_status_id": "8592e205-8c13-486b-9528-30e3e795f71a",
"project_status_code": "sample string 10",
"project_status": {
"id": "39ed17fc-da29-4499-a5ae-d58de1e6526e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e411e2ed-4589-43da-b65e-0fdb252e10e3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8356678d-263a-488e-8929-6a48459e5765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d2dfd71-3faf-42e3-8d9e-a6a4d3a09139",
"db_currency_id": "c125e132-5a3e-4407-8b4d-e13e75172b6e",
"db_language_id": "55b267d7-c052-45f7-bf8e-bec4811375ac",
"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-11-07T11:38:55.4655386+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-07T11:38:55.4655386+00:00"
},
"company_id": "f038dbf2-bee0-4df1-968a-5d0aca87bd7e",
"company_code": "sample string 12",
"db_address_id": "8d9492c0-5bd8-4f59-bf9c-4465fd6ef481",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "540d5dae-1c0e-4244-bcb5-b62f7655789e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9dbd15f2-af2a-4d81-b361-1e2dcf589811",
"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-11-07T11:38:55.4655386+00:00",
"date_create": "2026-11-07T11:38:55.4655386+00:00",
"date_update": "2026-11-07T11:38:55.4655386+00:00",
"updated_by_user_id": "7fe0892f-4b7d-434a-895e-91e65b673c9d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-07T11:38:55.4655386+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-11-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-07T11:38:55.4655386+00:00",
"date_last_job": "2026-11-07T11:38:55.4655386+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-07T11:38:55.4655386+00:00",
"modified_dateutc": "2026-11-07T11:38:55.4655386+00:00",
"is_mobile_installation": true
},
"job_type_id": "12be13f4-6fc4-4056-a1f3-277544478a5a",
"job_type_code": "sample string 7",
"job_type": {
"id": "b3e9af43-2685-49f5-84f9-d6c08b843381",
"name": "sample string 2",
"sales_organization_id": "a76c5c12-06c8-464e-b715-f02f71891ea3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-07T11:38:55.4655386+00:00",
"code": "sample string 7"
},
"job_priority_id": "80da9603-a2df-4532-9d16-bcd199df3522",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3ab0a849-510f-4e16-a6de-e0c4edb21075",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3b359e5c-19fc-41cd-85b9-bd446134bb64",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8356678d-263a-488e-8929-6a48459e5765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d2dfd71-3faf-42e3-8d9e-a6a4d3a09139",
"db_currency_id": "c125e132-5a3e-4407-8b4d-e13e75172b6e",
"db_language_id": "55b267d7-c052-45f7-bf8e-bec4811375ac",
"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-11-07T11:38:55.4655386+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-07T11:38:55.4655386+00:00"
},
"job_status_id": "35229bbc-91d2-407c-b678-5681b5d6ff14",
"job_status_code": "sample string 11",
"db_address_id": "658ca2de-4474-4a29-b7fc-2fd5deaf9a19",
"contact_id": "2cc2e0eb-21fd-4c28-a41e-0d2c51288727",
"requested_by_company_id": "e5a4871f-1f4e-4299-a1c8-5a4f761894bf",
"requested_by_contact_id": "bb5e3145-6cde-4b9d-99ca-f40b6aea3a2f",
"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-11-07T11:38:55.4655386+00:00",
"due_date": "2026-11-07T11:38:55.4655386+00:00",
"date_create": "2026-11-07T11:38:55.4655386+00:00",
"date_update": "2026-11-07T11:38:55.4655386+00:00",
"date_closed": "2026-11-07T11:38:55.4655386+00:00",
"suggested_user_id": "f4bd4b8f-b5b8-421d-b8ee-38a0345e611a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "629a0278-e64d-4146-a925-9c9930aedac0",
"db_language_id": "a90eb724-cc4f-44bc-888f-bdf11e0f1796",
"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-11-07T11:38:55.4655386+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "26d5f65b-2114-43ce-8034-5c9829414e44",
"sales_organization": {
"id": "8356678d-263a-488e-8929-6a48459e5765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d2dfd71-3faf-42e3-8d9e-a6a4d3a09139",
"db_currency_id": "c125e132-5a3e-4407-8b4d-e13e75172b6e",
"db_language_id": "55b267d7-c052-45f7-bf8e-bec4811375ac",
"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-11-07T11:38:55.4655386+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9e5617df-507a-468f-ba87-2f848ad38cd3",
"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": "ac97ee35-d816-49eb-a561-0f2e72d61df7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-07T11:38:55.4844984+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "44b1751d-02a1-444f-920e-b1483921c543"
},
"suggested_date_start": "2026-11-07T11:38:55.4844984+00:00",
"skill_id": "90fe47cf-05be-4015-a86f-32d4c8205bb1",
"skill_code": "sample string 32",
"skill": {
"id": "1c1059fc-81e6-42ae-8c3f-952a29f1c696",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ee17bda5-a039-4a96-8ecb-d5b9adcf5b94",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8356678d-263a-488e-8929-6a48459e5765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d2dfd71-3faf-42e3-8d9e-a6a4d3a09139",
"db_currency_id": "c125e132-5a3e-4407-8b4d-e13e75172b6e",
"db_language_id": "55b267d7-c052-45f7-bf8e-bec4811375ac",
"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-11-07T11:38:55.4655386+00:00"
},
"modified_dateutc": "2026-11-07T11:38:55.4844984+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "dc852582-6093-40fa-b2b8-32cf892af0ec",
"date_reported_by_company": "2026-11-07T11:38:55.4844984+00:00",
"id2": 36,
"company_id": "4448537d-c7f2-4b7f-9544-3ed2a8f15d56",
"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": "70a18785-0ad3-4473-a56a-1c0c28bed2ba",
"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-11-07T11:38:55.4844984+00:00"
},
"work_instruction_details_id": "f1330ddb-f138-4f91-a3f0-d07c420633f5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0326528e-a1be-4cc4-a6a5-f09ad35b202a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a94ace83-2c0b-42cc-a7b2-8e72eade6998",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-07T11:38:55.4844984+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": "b884f3f8-1289-4185-8ba4-bc1c6a5f9f92",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-07T11:38:55.4844984+00:00"
}