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": "7a46c7a7-b567-4d86-b58f-73014477c9ee",
"jobs_id": "e73534ce-e131-442c-acb9-ea81a6d8e45c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a29dea5b-6703-4f63-ad92-3e86c83025c1",
"_parent_id": "93879524-9695-4d2a-b374-0c73258c7138",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4aaa1f7b-b027-4fae-aa5c-7b3cc6b5c512",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8a0ec10f-eab5-427c-b586-a949ddbb2463",
"_parent_id": "aed8bd14-9073-4522-988d-dbe40bc89b37",
"root_parent_id": "30060cd6-b12e-4355-807d-5ce7db4cbc2c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ab3e94d5-4b45-40f1-9884-3505460c5d65",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ab8daa67-8abb-4aa1-ab8f-fd0aee60836f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e8fb6eeb-86c3-4604-b526-f30a1a0f475b",
"_parent_code": "sample string 6",
"sales_organization_id": "cc224a2c-60fd-4fe2-952c-9b383cb4d76a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0efe1676-a351-4fee-a915-51f2518a6a1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "997d4d6c-c9d1-4bcc-9b84-532d11b3c190",
"db_currency_id": "7b0a0663-dab2-479c-8168-88327f1d4503",
"db_language_id": "ab0134c1-f903-4fcc-8d16-1f322c808247",
"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-03-31T13:23:03.0626487+00:00"
},
"modified_dateutc": "2025-03-31T13:23:03.0626487+00:00"
},
"equipment_model_id": "266cd924-315c-4ebc-9c37-b88dc4098605",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6e3ba521-12fb-43df-ad98-7f60009214b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0f2ce94a-a8cf-46bd-8027-4b3bb083cc95",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "698816b1-7349-4120-9a62-ca3a13aca037",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5c35ac02-4557-4779-9bda-802f16465919",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0efe1676-a351-4fee-a915-51f2518a6a1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "997d4d6c-c9d1-4bcc-9b84-532d11b3c190",
"db_currency_id": "7b0a0663-dab2-479c-8168-88327f1d4503",
"db_language_id": "ab0134c1-f903-4fcc-8d16-1f322c808247",
"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-03-31T13:23:03.0626487+00:00"
},
"modified_dateutc": "2025-03-31T13:23:03.0782722+00:00"
},
"equipment_family_id": "a892ca0a-6c8e-435f-8098-66e1e99a94d0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ab8daa67-8abb-4aa1-ab8f-fd0aee60836f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e8fb6eeb-86c3-4604-b526-f30a1a0f475b",
"_parent_code": "sample string 6",
"sales_organization_id": "cc224a2c-60fd-4fe2-952c-9b383cb4d76a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0efe1676-a351-4fee-a915-51f2518a6a1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "997d4d6c-c9d1-4bcc-9b84-532d11b3c190",
"db_currency_id": "7b0a0663-dab2-479c-8168-88327f1d4503",
"db_language_id": "ab0134c1-f903-4fcc-8d16-1f322c808247",
"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-03-31T13:23:03.0626487+00:00"
},
"modified_dateutc": "2025-03-31T13:23:03.0626487+00:00"
},
"date_in_production_since": "2025-03-31T13:23:03.0782722+00:00",
"date_out_of_production_since": "2025-03-31T13:23:03.0782722+00:00",
"date_end_support": "2025-03-31T13:23:03.0782722+00:00",
"sales_organization_id": "d9d4e425-49ce-4282-8c7c-278dc22238a8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0efe1676-a351-4fee-a915-51f2518a6a1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "997d4d6c-c9d1-4bcc-9b84-532d11b3c190",
"db_currency_id": "7b0a0663-dab2-479c-8168-88327f1d4503",
"db_language_id": "ab0134c1-f903-4fcc-8d16-1f322c808247",
"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-03-31T13:23:03.0626487+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-03-31T13:23:03.0782722+00:00"
},
"project_status_id": "d3d5f311-67fc-4a44-abdd-82674e75221d",
"project_status_code": "sample string 10",
"project_status": {
"id": "4781c68c-d8f3-4e65-ac73-8791dc8fbacf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4996e247-6346-4dc2-99cb-444c31156c3d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0efe1676-a351-4fee-a915-51f2518a6a1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "997d4d6c-c9d1-4bcc-9b84-532d11b3c190",
"db_currency_id": "7b0a0663-dab2-479c-8168-88327f1d4503",
"db_language_id": "ab0134c1-f903-4fcc-8d16-1f322c808247",
"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-03-31T13:23:03.0626487+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-31T13:23:03.0782722+00:00"
},
"company_id": "143b5283-0969-4f41-8702-eb4235869025",
"company_code": "sample string 12",
"db_address_id": "4f3fadef-c712-4432-a776-9b96398dbd80",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2abc1483-dee4-4959-93dc-caa2a65780d4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "37d4512d-35e8-4cfd-93fe-262824933bdc",
"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-03-31T13:23:03.0782722+00:00",
"date_create": "2025-03-31T13:23:03.0782722+00:00",
"date_update": "2025-03-31T13:23:03.0782722+00:00",
"updated_by_user_id": "c6acd661-a2b5-4dde-9e7a-e65eae7f0779",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-03-31T13:23:03.0782722+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-03-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-03-31T13:23:03.0782722+00:00",
"date_last_job": "2025-03-31T13:23:03.0782722+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-03-31T13:23:03.0782722+00:00",
"modified_dateutc": "2025-03-31T13:23:03.0782722+00:00",
"is_mobile_installation": true
},
"job_type_id": "8b5b4544-a348-46b1-a49b-df8fd685b6ed",
"job_type_code": "sample string 7",
"job_type": {
"id": "89dc080f-5437-4ad2-a5ce-ff21700af7d4",
"name": "sample string 2",
"sales_organization_id": "c80bc808-81fd-45b3-810c-d8ff77184b4c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-03-31T13:23:03.0782722+00:00",
"code": "sample string 7"
},
"job_priority_id": "72952c7a-1d91-4e19-8ab5-af8cab3f3455",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b842d8c3-318a-4aaa-bd9c-97ced9af4278",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "45d9da4a-bb94-4984-9bb2-cc172cd97670",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0efe1676-a351-4fee-a915-51f2518a6a1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "997d4d6c-c9d1-4bcc-9b84-532d11b3c190",
"db_currency_id": "7b0a0663-dab2-479c-8168-88327f1d4503",
"db_language_id": "ab0134c1-f903-4fcc-8d16-1f322c808247",
"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-03-31T13:23:03.0626487+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-31T13:23:03.0782722+00:00"
},
"job_status_id": "f0c4f0a7-4542-4715-aca5-49a228faade7",
"job_status_code": "sample string 11",
"db_address_id": "6bcd4c47-d59d-478b-9144-9e89f4182f2f",
"contact_id": "49d76977-b1f0-458e-bb69-b3349893bd56",
"requested_by_company_id": "4a8fe558-4a4f-44f8-b5a0-05b273cbfda9",
"requested_by_contact_id": "3154849b-eee6-4153-8bb2-e97f58febb0c",
"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-03-31T13:23:03.0782722+00:00",
"due_date": "2025-03-31T13:23:03.0782722+00:00",
"date_create": "2025-03-31T13:23:03.0782722+00:00",
"date_update": "2025-03-31T13:23:03.0782722+00:00",
"date_closed": "2025-03-31T13:23:03.0782722+00:00",
"suggested_user_id": "4b97be1a-043c-488e-8cae-a4d84df888f3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4cbe0a7a-cd44-4bc7-b08c-eec44f13838e",
"db_language_id": "cccbd1ab-eb3a-4173-a5ad-7ac533c17d96",
"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-03-31T13:23:03.0782722+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "855f873c-0dde-439d-a31a-f602dced29f0",
"sales_organization": {
"id": "0efe1676-a351-4fee-a915-51f2518a6a1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "997d4d6c-c9d1-4bcc-9b84-532d11b3c190",
"db_currency_id": "7b0a0663-dab2-479c-8168-88327f1d4503",
"db_language_id": "ab0134c1-f903-4fcc-8d16-1f322c808247",
"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-03-31T13:23:03.0626487+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5f51d5bc-a48f-4e18-9420-046e0d86693e",
"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": "89a833a2-8c83-466e-9390-0f24f9f57162",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-03-31T13:23:03.0782722+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9face271-424f-4ee5-922b-1f09bc69afc6"
},
"suggested_date_start": "2025-03-31T13:23:03.0782722+00:00",
"skill_id": "776eac1c-888a-4feb-9bc2-b6d4c0a9060e",
"skill_code": "sample string 32",
"skill": {
"id": "1a5b9390-dbed-4b48-97ca-2e8155f6476d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a4515109-6f9b-40fc-a829-a8141dd35d09",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0efe1676-a351-4fee-a915-51f2518a6a1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "997d4d6c-c9d1-4bcc-9b84-532d11b3c190",
"db_currency_id": "7b0a0663-dab2-479c-8168-88327f1d4503",
"db_language_id": "ab0134c1-f903-4fcc-8d16-1f322c808247",
"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-03-31T13:23:03.0626487+00:00"
},
"modified_dateutc": "2025-03-31T13:23:03.0782722+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "890fb2f1-a15f-4262-845c-fe5f10618bb2",
"date_reported_by_company": "2025-03-31T13:23:03.0782722+00:00",
"id2": 36,
"company_id": "3cb310d4-2e46-40c6-9850-c12ce686968e",
"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": "e5346247-eb94-416a-9a19-aa2f5fa3cc70",
"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-03-31T13:23:03.0782722+00:00"
},
"work_instruction_details_id": "cb16f19d-5176-4487-bdae-d58e9a94c904",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "211bd7c0-5bde-41cb-bac2-46583456e594",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8bf29a9a-bdd6-44c1-acc6-69cc56453904",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-03-31T13:23:03.0782722+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": "33c04d45-3f46-4de7-98f9-a355d6aa9540",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-03-31T13:23:03.0782722+00:00"
}