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": "179e96d3-6c80-42e4-8da4-0453eecd88bf",
"jobs_id": "c970db09-6450-489d-bed8-f677521e9643",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8522a47d-0c7e-4931-b6bd-f6ce751cfc8c",
"_parent_id": "8b8561c3-43e5-44c1-a18c-adff75ec1c73",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2ae8e712-7a97-49ac-906d-53a90590b9c2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2830558a-02a8-4d01-bac4-1560d91fe1eb",
"_parent_id": "91aa6c08-de4e-467c-9b0a-a19ae433a1aa",
"root_parent_id": "b5180385-14b2-4607-9e09-eaea9a11b4e4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "259439c6-147c-48c7-8ea7-820da14137ca",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b9541541-e91c-4986-8163-f4d8616babbd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bf8f72cc-4d02-4c1a-a49c-6e82320b2eb2",
"_parent_code": "sample string 6",
"sales_organization_id": "5bc7fae7-b9fd-4dd8-9ac4-4dc235a084b3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9a6b5446-93c8-4a2c-9860-bc7fd0cff06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daea58e1-fcb3-4bbb-bcb9-adc4c78189a1",
"db_currency_id": "756e44e7-6066-4e5b-90b6-4af40728bf2c",
"db_language_id": "c0d3e703-50bf-4fb8-b120-6148bcd6e214",
"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": "2023-06-08T10:48:39.650318+00:00"
},
"modified_dateutc": "2023-06-08T10:48:39.650318+00:00"
},
"equipment_model_id": "2b198e69-a1d1-435c-b722-d065ddd3a28d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bf3c879b-118a-42e2-bf4c-8bae19b50389",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b0c758f1-3517-46fe-871e-9d670d2a4cf7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d4471366-9653-4a8a-9cbc-ec252e67c2ae",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "aad6dbe1-c557-4192-85fa-fd22a516ec8e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9a6b5446-93c8-4a2c-9860-bc7fd0cff06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daea58e1-fcb3-4bbb-bcb9-adc4c78189a1",
"db_currency_id": "756e44e7-6066-4e5b-90b6-4af40728bf2c",
"db_language_id": "c0d3e703-50bf-4fb8-b120-6148bcd6e214",
"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": "2023-06-08T10:48:39.650318+00:00"
},
"modified_dateutc": "2023-06-08T10:48:39.650318+00:00"
},
"equipment_family_id": "c510962c-84ce-472c-88e4-39cbd076111a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b9541541-e91c-4986-8163-f4d8616babbd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bf8f72cc-4d02-4c1a-a49c-6e82320b2eb2",
"_parent_code": "sample string 6",
"sales_organization_id": "5bc7fae7-b9fd-4dd8-9ac4-4dc235a084b3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9a6b5446-93c8-4a2c-9860-bc7fd0cff06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daea58e1-fcb3-4bbb-bcb9-adc4c78189a1",
"db_currency_id": "756e44e7-6066-4e5b-90b6-4af40728bf2c",
"db_language_id": "c0d3e703-50bf-4fb8-b120-6148bcd6e214",
"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": "2023-06-08T10:48:39.650318+00:00"
},
"modified_dateutc": "2023-06-08T10:48:39.650318+00:00"
},
"date_in_production_since": "2023-06-08T10:48:39.650318+00:00",
"date_out_of_production_since": "2023-06-08T10:48:39.650318+00:00",
"date_end_support": "2023-06-08T10:48:39.650318+00:00",
"sales_organization_id": "4b2eeed1-ecab-4ef3-b03c-c88bf54599f4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9a6b5446-93c8-4a2c-9860-bc7fd0cff06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daea58e1-fcb3-4bbb-bcb9-adc4c78189a1",
"db_currency_id": "756e44e7-6066-4e5b-90b6-4af40728bf2c",
"db_language_id": "c0d3e703-50bf-4fb8-b120-6148bcd6e214",
"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": "2023-06-08T10:48:39.650318+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": "2023-06-08T10:48:39.650318+00:00"
},
"project_status_id": "b46ee2f8-3293-40de-be5a-b1e6998fab14",
"project_status_code": "sample string 10",
"project_status": {
"id": "d3e05ab1-0561-4cb6-968f-112f4385dc64",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bbd03974-1328-433e-83d8-e9b47bfb9886",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9a6b5446-93c8-4a2c-9860-bc7fd0cff06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daea58e1-fcb3-4bbb-bcb9-adc4c78189a1",
"db_currency_id": "756e44e7-6066-4e5b-90b6-4af40728bf2c",
"db_language_id": "c0d3e703-50bf-4fb8-b120-6148bcd6e214",
"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": "2023-06-08T10:48:39.650318+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-06-08T10:48:39.650318+00:00"
},
"company_id": "4c9bdcf2-d3ca-4b68-b7d9-481f4de15e9b",
"company_code": "sample string 12",
"db_address_id": "c407d5ed-08f3-49ef-83de-77bdd51e2def",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f5b4e865-8ead-4a1c-a0c7-01e1cdfc53c6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ccaf365b-28eb-4172-b390-050ab3e4015c",
"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": "2023-06-08T10:48:39.650318+00:00",
"date_create": "2023-06-08T10:48:39.650318+00:00",
"date_update": "2023-06-08T10:48:39.650318+00:00",
"updated_by_user_id": "999aa612-0371-41ab-aa01-3adb3c94bf0e",
"customer_reference": "sample string 28",
"warranty_date_until": "2023-06-08T10:48:39.650318+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": "2023-06-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2023-06-08T10:48:39.650318+00:00",
"date_last_job": "2023-06-08T10:48:39.650318+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2023-06-08T10:48:39.650318+00:00",
"modified_dateutc": "2023-06-08T10:48:39.650318+00:00",
"is_mobile_installation": true
},
"job_type_id": "762df567-3984-40e3-bdce-65ab5d5932fe",
"job_type_code": "sample string 7",
"job_type": {
"id": "2fc42232-bc7e-45df-94bf-6b60261ae5b0",
"name": "sample string 2",
"sales_organization_id": "a69b33d3-3607-4d74-9d64-b654332770de",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2023-06-08T10:48:39.650318+00:00",
"code": "sample string 7"
},
"job_priority_id": "8dd46b87-f4f4-43d4-8e5b-1ea1348c6656",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c2137be8-7a59-4053-903e-e06675abab6c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c95deb75-a0f7-41a6-b0c2-4637ff03688b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9a6b5446-93c8-4a2c-9860-bc7fd0cff06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daea58e1-fcb3-4bbb-bcb9-adc4c78189a1",
"db_currency_id": "756e44e7-6066-4e5b-90b6-4af40728bf2c",
"db_language_id": "c0d3e703-50bf-4fb8-b120-6148bcd6e214",
"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": "2023-06-08T10:48:39.650318+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-06-08T10:48:39.650318+00:00"
},
"job_status_id": "f1553605-6ffb-4ea9-89f2-141b8c9eeb03",
"job_status_code": "sample string 11",
"db_address_id": "45ee59af-6af0-4ba1-9670-d4b611eb75f7",
"contact_id": "e9a1dc23-090b-4d82-b220-643cfcaaacdd",
"requested_by_company_id": "9ddd9d3f-ac5c-41f5-9d50-046f5da90b58",
"requested_by_contact_id": "4a94e5f4-5d77-4d52-a44c-6344238a611e",
"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": "2023-06-08T10:48:39.650318+00:00",
"due_date": "2023-06-08T10:48:39.650318+00:00",
"date_create": "2023-06-08T10:48:39.650318+00:00",
"date_update": "2023-06-08T10:48:39.650318+00:00",
"date_closed": "2023-06-08T10:48:39.650318+00:00",
"suggested_user_id": "093fc448-a4e4-4548-975a-74ce36440faf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "289ee60e-95d3-41a9-b78c-9389ac73f918",
"db_language_id": "c945b102-73d5-4c6d-a1cf-bdff9ac6048d",
"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": "2023-06-08T10:48:39.650318+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8406107b-1c84-45ec-a426-363a86db1d2b",
"sales_organization": {
"id": "9a6b5446-93c8-4a2c-9860-bc7fd0cff06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daea58e1-fcb3-4bbb-bcb9-adc4c78189a1",
"db_currency_id": "756e44e7-6066-4e5b-90b6-4af40728bf2c",
"db_language_id": "c0d3e703-50bf-4fb8-b120-6148bcd6e214",
"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": "2023-06-08T10:48:39.650318+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b8701538-1be9-49c9-b8a5-b3fbf64d867f",
"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": "d1952ec0-e1ee-4bc8-bcc8-65e819e6de35",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2023-06-08T10:48:39.650318+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0d1f50fb-5221-486e-a27d-adf207b86b48"
},
"suggested_date_start": "2023-06-08T10:48:39.650318+00:00",
"skill_id": "8bc4474f-6941-4bed-8766-e2a859571255",
"skill_code": "sample string 32",
"skill": {
"id": "431d2b84-9053-4db1-a9fa-725581ba076e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bfd5f677-6205-4aaa-b866-c720d7c1ef26",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9a6b5446-93c8-4a2c-9860-bc7fd0cff06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daea58e1-fcb3-4bbb-bcb9-adc4c78189a1",
"db_currency_id": "756e44e7-6066-4e5b-90b6-4af40728bf2c",
"db_language_id": "c0d3e703-50bf-4fb8-b120-6148bcd6e214",
"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": "2023-06-08T10:48:39.650318+00:00"
},
"modified_dateutc": "2023-06-08T10:48:39.650318+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "70c31785-896b-41d6-a837-540407ee15e9",
"date_reported_by_company": "2023-06-08T10:48:39.650318+00:00",
"id2": 36,
"company_id": "569987c0-b1e7-4080-b74c-c33f57d0435b",
"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": "ddb038bc-a324-4bd9-8438-aba87cc9c6c5",
"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": "2023-06-08T10:48:39.650318+00:00"
},
"work_instruction_details_id": "c51770c0-1999-44f4-b3cb-b6e8a0c858e5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7f39ee8c-481b-4ece-b8e8-98671944139f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a8a0413e-2876-4a78-a884-7e54c0222ea6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2023-06-08T10:48:39.650318+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": "7c63fea3-940b-4d95-9623-07578bd0ad09",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2023-06-08T10:48:39.650318+00:00"
}