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: 50 |
| 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: 50 |
| 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": "49d4f0e9-67a2-4e39-b766-b56cce27f659",
"jobs_id": "cf656eb8-a01d-4c66-a4d7-30b82fdf9c15",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2448c61a-aa93-49e5-a403-687918bbb417",
"_parent_id": "39ccfdd8-989d-4d27-af48-b3034134f314",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "84c7d9b3-424b-4e58-8b7b-6ed3704de063",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f8200e0b-1fa2-40ad-b808-35fb7924b79d",
"_parent_id": "07b69969-0378-405d-86f1-bbef3e731582",
"root_parent_id": "8980c3fd-fd40-4203-8634-03f263ebd2ad",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8d70c776-26c6-49ad-a021-5ce3f4d7a2db",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e9379d15-2f86-4b8d-8cd6-33dd1f4e72cf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "28df3ee5-d491-4a85-8a21-bf013a26661c",
"_parent_code": "sample string 6",
"sales_organization_id": "0fb26988-f1a0-4697-ab70-6a40735d4e9a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "08a96db9-1c24-40aa-831b-dec89eadb8ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dbb5e9f7-aa46-47cf-96fe-716f82d366ed",
"db_currency_id": "1ca35bf1-a329-475f-aeb1-050fd337b83e",
"db_language_id": "c2f64cd3-6340-4148-8a57-14adbd246ae4",
"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": "2022-08-17T02:37:10.1130708+02:00"
},
"modified_dateutc": "2022-08-17T02:37:10.1130708+02:00"
},
"equipment_model_id": "23cf8dd3-1357-483b-97ff-da4e606ae461",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8844aae7-a14c-4be3-9ac8-939119ecbb20",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "edb6e9e8-5380-480a-8461-798135a93a52",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8516b650-ccbb-4d2b-af7d-378740228b87",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c8b432e7-30c4-43d2-98c0-1aaf7131768a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "08a96db9-1c24-40aa-831b-dec89eadb8ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dbb5e9f7-aa46-47cf-96fe-716f82d366ed",
"db_currency_id": "1ca35bf1-a329-475f-aeb1-050fd337b83e",
"db_language_id": "c2f64cd3-6340-4148-8a57-14adbd246ae4",
"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": "2022-08-17T02:37:10.1130708+02:00"
},
"modified_dateutc": "2022-08-17T02:37:10.1130708+02:00"
},
"equipment_family_id": "e09576d0-51c9-42af-ba5b-d2ee55a5b2f0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e9379d15-2f86-4b8d-8cd6-33dd1f4e72cf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "28df3ee5-d491-4a85-8a21-bf013a26661c",
"_parent_code": "sample string 6",
"sales_organization_id": "0fb26988-f1a0-4697-ab70-6a40735d4e9a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "08a96db9-1c24-40aa-831b-dec89eadb8ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dbb5e9f7-aa46-47cf-96fe-716f82d366ed",
"db_currency_id": "1ca35bf1-a329-475f-aeb1-050fd337b83e",
"db_language_id": "c2f64cd3-6340-4148-8a57-14adbd246ae4",
"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": "2022-08-17T02:37:10.1130708+02:00"
},
"modified_dateutc": "2022-08-17T02:37:10.1130708+02:00"
},
"date_in_production_since": "2022-08-17T02:37:10.1130708+02:00",
"date_out_of_production_since": "2022-08-17T02:37:10.1130708+02:00",
"date_end_support": "2022-08-17T02:37:10.1130708+02:00",
"sales_organization_id": "9589da60-f240-4be8-a42a-e4d507dd7610",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "08a96db9-1c24-40aa-831b-dec89eadb8ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dbb5e9f7-aa46-47cf-96fe-716f82d366ed",
"db_currency_id": "1ca35bf1-a329-475f-aeb1-050fd337b83e",
"db_language_id": "c2f64cd3-6340-4148-8a57-14adbd246ae4",
"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": "2022-08-17T02:37:10.1130708+02: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": "2022-08-17T02:37:10.1130708+02:00"
},
"project_status_id": "65cee1db-74f0-4d72-b479-0dae8a4191da",
"project_status_code": "sample string 10",
"project_status": {
"id": "79c295b2-65ae-4e3f-b46b-f220ac5af4e0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8da33f09-a4ba-4a83-b24e-d5d746e5c428",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "08a96db9-1c24-40aa-831b-dec89eadb8ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dbb5e9f7-aa46-47cf-96fe-716f82d366ed",
"db_currency_id": "1ca35bf1-a329-475f-aeb1-050fd337b83e",
"db_language_id": "c2f64cd3-6340-4148-8a57-14adbd246ae4",
"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": "2022-08-17T02:37:10.1130708+02:00"
},
"code": "sample string 7",
"modified_dateutc": "2022-08-17T02:37:10.1130708+02:00"
},
"company_id": "db4a0aa7-0b79-44a9-b0a4-300fad0f3cb0",
"company_code": "sample string 12",
"db_address_id": "a9fd8a26-240e-4188-83f1-5025b9ee63dc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "411ae248-2f35-48bf-9056-c43c8336a720",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "580aa333-08ea-446f-9e49-493e266ac962",
"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": "2022-08-17T02:37:10.1130708+02:00",
"date_create": "2022-08-17T02:37:10.1130708+02:00",
"date_update": "2022-08-17T02:37:10.1130708+02:00",
"updated_by_user_id": "725aa054-16d3-4cae-af16-38e758f6881b",
"customer_reference": "sample string 28",
"warranty_date_until": "2022-08-17T02:37:10.1130708+02: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": "2022-08-17T00:00:00+02:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2022-08-17T02:37:10.1130708+02:00",
"date_last_job": "2022-08-17T02:37:10.1130708+02:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2022-08-17T02:37:10.1130708+02:00",
"modified_dateutc": "2022-08-17T02:37:10.1311003+02:00",
"is_mobile_installation": true
},
"job_type_id": "9283e657-8b59-4de6-bcf2-c2cd2451f03c",
"job_type_code": "sample string 7",
"job_type": {
"id": "53080922-d8c8-453a-94f3-95c056c380e4",
"name": "sample string 2",
"sales_organization_id": "24adf51b-0bd1-4a60-b570-9c3617c8d494",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2022-08-17T02:37:10.1311003+02:00",
"code": "sample string 7"
},
"job_priority_id": "814e5fef-c502-468d-9f40-ef6029b06627",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6655efa5-b3ab-4ee9-8814-eb20a0dd9f86",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "70fb8905-b2fc-4a5d-b921-053863bd5016",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "08a96db9-1c24-40aa-831b-dec89eadb8ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dbb5e9f7-aa46-47cf-96fe-716f82d366ed",
"db_currency_id": "1ca35bf1-a329-475f-aeb1-050fd337b83e",
"db_language_id": "c2f64cd3-6340-4148-8a57-14adbd246ae4",
"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": "2022-08-17T02:37:10.1130708+02:00"
},
"code": "sample string 7",
"modified_dateutc": "2022-08-17T02:37:10.1311003+02:00"
},
"job_status_id": "578b14f7-e2ac-4235-b8fe-5b32c662911a",
"job_status_code": "sample string 11",
"db_address_id": "2f2fa29b-2fea-4873-bafc-fe7b99c0eded",
"contact_id": "3c3a8c61-eafe-4d88-a9c0-18460483da88",
"requested_by_company_id": "9d1d2918-8f4b-4041-b830-072d06f22123",
"requested_by_contact_id": "5a11967b-ffb3-4e45-9af6-3b257aa7735d",
"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": "2022-08-17T02:37:10.1311003+02:00",
"due_date": "2022-08-17T02:37:10.1311003+02:00",
"date_create": "2022-08-17T02:37:10.1311003+02:00",
"date_update": "2022-08-17T02:37:10.1311003+02:00",
"date_closed": "2022-08-17T02:37:10.1311003+02:00",
"suggested_user_id": "ee0d7fdb-97f0-4737-8aef-1545314c3040",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "34e7ab69-9d3b-4bca-b534-3b5ebc069747",
"db_language_id": "f8dff853-6326-42ae-bce1-9147ba725dc2",
"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": "2022-08-17T02:37:10.1311003+02:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dc65cd6a-fa0d-4ebd-b0c2-5aa911d65c6f",
"sales_organization": {
"id": "08a96db9-1c24-40aa-831b-dec89eadb8ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dbb5e9f7-aa46-47cf-96fe-716f82d366ed",
"db_currency_id": "1ca35bf1-a329-475f-aeb1-050fd337b83e",
"db_language_id": "c2f64cd3-6340-4148-8a57-14adbd246ae4",
"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": "2022-08-17T02:37:10.1130708+02:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a0e87e92-c032-4a1c-94be-e6a5fa7d13b3",
"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": "4880cfd4-fa81-4a42-b0bd-a7b88ac09c6d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2022-08-17T02:37:10.1311003+02:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "72b596e3-8704-4110-afa3-d8a330d1041d"
},
"suggested_date_start": "2022-08-17T02:37:10.1311003+02:00",
"skill_id": "fa02c819-9efc-49fb-8d56-4ef11940ae38",
"skill_code": "sample string 32",
"skill": {
"id": "8581ac8e-387e-4c19-81c0-7fde9ed54ba3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8276a6a1-afe8-4dcd-b0c3-afe949837467",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "08a96db9-1c24-40aa-831b-dec89eadb8ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dbb5e9f7-aa46-47cf-96fe-716f82d366ed",
"db_currency_id": "1ca35bf1-a329-475f-aeb1-050fd337b83e",
"db_language_id": "c2f64cd3-6340-4148-8a57-14adbd246ae4",
"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": "2022-08-17T02:37:10.1130708+02:00"
},
"modified_dateutc": "2022-08-17T02:37:10.1311003+02:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "74ad09c3-81c3-48c0-8b02-eb5fe99c6090",
"date_reported_by_company": "2022-08-17T02:37:10.1311003+02:00",
"id2": 36,
"company_id": "d5dafaac-13f5-42d5-8689-86569b9481ee",
"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": "cffd4e4c-6d90-462f-81b7-e6a900e6fc34",
"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": "2022-08-17T02:37:10.1311003+02:00"
},
"work_instruction_details_id": "8e8142fc-0e42-41f7-90f8-ebd0a3543095",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d6bf090e-2ff0-4530-a4bf-c636928c5fd9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "05071263-a393-45e4-a8bb-62ee5b64aeec",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2022-08-17T02:37:10.1311003+02: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": "772c488a-2118-48a1-9b1c-a27a79adda15",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2022-08-17T02:37:10.1311003+02:00"
}