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": "88d81c1b-32a2-41ae-9de1-6821e0571592",
"jobs_id": "3b89b6bc-792a-47de-b81a-8960a4bbe1be",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "96fcb251-74fc-48cd-aaf6-895f542febce",
"_parent_id": "6c5c9b5c-2ef7-4006-aca4-71f32e7ab430",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "23bd25da-1be6-4f74-a312-9ef82a6a6df6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "00df98da-f1b8-4005-909f-8e4d78418927",
"_parent_id": "fcb114c5-e840-4a4e-b8a5-d79a7c577eb5",
"root_parent_id": "913c02c4-5af3-47c8-8165-0065440e05ee",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e0f026fc-e932-4a5c-98c4-43201608d401",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3a3d38ba-8877-4192-8986-3a9449fbf4a2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bc1ff163-1091-4b45-90c9-7a094fdc7131",
"_parent_code": "sample string 6",
"sales_organization_id": "8b1a4213-08cb-4174-a2da-31612aa2424f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "14179e2a-512e-4e02-9246-0f2a41fdce38",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8b7fdcb-77ca-46d9-b0ad-98bce776c473",
"db_currency_id": "b58ce939-6eed-4bf7-980f-fd6f66a9dbaf",
"db_language_id": "450ed488-1b0f-46ca-b938-5567504531f9",
"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": "2024-04-22T01:49:39.8830944+00:00"
},
"modified_dateutc": "2024-04-22T01:49:39.8830944+00:00"
},
"equipment_model_id": "43e989c4-f557-4a5c-8200-954763a4ffa9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "62cc4d72-6f2f-41da-896c-47c669044ecd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c7e44079-70b2-4a14-b4da-5aeb1c7bff0f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1a600ba6-2510-441c-8b6f-5931988d409e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "df34b86b-3196-4fba-9a50-6be38272822d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "14179e2a-512e-4e02-9246-0f2a41fdce38",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8b7fdcb-77ca-46d9-b0ad-98bce776c473",
"db_currency_id": "b58ce939-6eed-4bf7-980f-fd6f66a9dbaf",
"db_language_id": "450ed488-1b0f-46ca-b938-5567504531f9",
"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": "2024-04-22T01:49:39.8830944+00:00"
},
"modified_dateutc": "2024-04-22T01:49:39.8830944+00:00"
},
"equipment_family_id": "78c63cf0-b8ba-4c4d-b928-6344198c5ad8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3a3d38ba-8877-4192-8986-3a9449fbf4a2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bc1ff163-1091-4b45-90c9-7a094fdc7131",
"_parent_code": "sample string 6",
"sales_organization_id": "8b1a4213-08cb-4174-a2da-31612aa2424f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "14179e2a-512e-4e02-9246-0f2a41fdce38",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8b7fdcb-77ca-46d9-b0ad-98bce776c473",
"db_currency_id": "b58ce939-6eed-4bf7-980f-fd6f66a9dbaf",
"db_language_id": "450ed488-1b0f-46ca-b938-5567504531f9",
"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": "2024-04-22T01:49:39.8830944+00:00"
},
"modified_dateutc": "2024-04-22T01:49:39.8830944+00:00"
},
"date_in_production_since": "2024-04-22T01:49:39.8830944+00:00",
"date_out_of_production_since": "2024-04-22T01:49:39.8830944+00:00",
"date_end_support": "2024-04-22T01:49:39.8830944+00:00",
"sales_organization_id": "69b64277-9842-4b90-a80c-cbb8644a3812",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "14179e2a-512e-4e02-9246-0f2a41fdce38",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8b7fdcb-77ca-46d9-b0ad-98bce776c473",
"db_currency_id": "b58ce939-6eed-4bf7-980f-fd6f66a9dbaf",
"db_language_id": "450ed488-1b0f-46ca-b938-5567504531f9",
"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": "2024-04-22T01:49:39.8830944+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": "2024-04-22T01:49:39.8830944+00:00"
},
"project_status_id": "a1c2205a-cd0b-4fcb-b390-79814ff3ddad",
"project_status_code": "sample string 10",
"project_status": {
"id": "72becf23-225d-4654-aa6d-8cfd0fbefbf7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f4bfe385-ffae-426a-9cec-3bfdf58b0076",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "14179e2a-512e-4e02-9246-0f2a41fdce38",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8b7fdcb-77ca-46d9-b0ad-98bce776c473",
"db_currency_id": "b58ce939-6eed-4bf7-980f-fd6f66a9dbaf",
"db_language_id": "450ed488-1b0f-46ca-b938-5567504531f9",
"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": "2024-04-22T01:49:39.8830944+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-22T01:49:39.8830944+00:00"
},
"company_id": "d524fdde-a46f-42d8-9e35-73db0ec78b60",
"company_code": "sample string 12",
"db_address_id": "3298e7fc-66f7-4b6b-bcdf-c593084ddcc1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "31e5f0e0-7141-4f4c-a0c8-d230272f25e6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "22942478-31a3-4c8a-ae57-f5dbae14c2e6",
"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": "2024-04-22T01:49:39.8830944+00:00",
"date_create": "2024-04-22T01:49:39.8830944+00:00",
"date_update": "2024-04-22T01:49:39.8830944+00:00",
"updated_by_user_id": "4a301df7-47ed-43e7-8a39-fb394c75e60f",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-04-22T01:49:39.8830944+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": "2024-04-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-04-22T01:49:39.8830944+00:00",
"date_last_job": "2024-04-22T01:49:39.8830944+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-04-22T01:49:39.8830944+00:00",
"modified_dateutc": "2024-04-22T01:49:39.8830944+00:00",
"is_mobile_installation": true
},
"job_type_id": "9c7887b9-710f-4f8e-a01e-f6ffb5173691",
"job_type_code": "sample string 7",
"job_type": {
"id": "bd62e944-e0f0-47f0-bbcf-5b833a766dd0",
"name": "sample string 2",
"sales_organization_id": "5b8506ce-029d-4b73-9cdd-e7116ec25acc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-04-22T01:49:39.8830944+00:00",
"code": "sample string 7"
},
"job_priority_id": "68d61cfa-7e89-4a89-8afc-7dc003919035",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3ec6e165-9780-421f-bb92-fd0b6a72d579",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "198b5f58-1211-4415-97a1-30c0e2bb5090",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "14179e2a-512e-4e02-9246-0f2a41fdce38",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8b7fdcb-77ca-46d9-b0ad-98bce776c473",
"db_currency_id": "b58ce939-6eed-4bf7-980f-fd6f66a9dbaf",
"db_language_id": "450ed488-1b0f-46ca-b938-5567504531f9",
"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": "2024-04-22T01:49:39.8830944+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-22T01:49:39.8830944+00:00"
},
"job_status_id": "89e62174-222f-4fbe-bd9f-854d7bc6c942",
"job_status_code": "sample string 11",
"db_address_id": "215fa789-c466-47d9-946b-e15339af7a49",
"contact_id": "244dafeb-6302-4e7a-88a4-0bea8028fe25",
"requested_by_company_id": "3ce5c975-5b84-439d-8628-d5cd3b10a673",
"requested_by_contact_id": "d0ef67fa-279a-455a-a0ff-52c625bfd5a5",
"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": "2024-04-22T01:49:39.8830944+00:00",
"due_date": "2024-04-22T01:49:39.8830944+00:00",
"date_create": "2024-04-22T01:49:39.8830944+00:00",
"date_update": "2024-04-22T01:49:39.8830944+00:00",
"date_closed": "2024-04-22T01:49:39.8830944+00:00",
"suggested_user_id": "2667a16a-86fb-45c5-a1ca-2013e6d60082",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "337a9e4b-7130-4ade-a951-af129f2bc625",
"db_language_id": "f87ba65f-90d0-4e55-9649-b8712050f0db",
"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": "2024-04-22T01:49:39.8830944+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "be924a34-84b1-4c4b-8f0d-79db4af0b4db",
"sales_organization": {
"id": "14179e2a-512e-4e02-9246-0f2a41fdce38",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8b7fdcb-77ca-46d9-b0ad-98bce776c473",
"db_currency_id": "b58ce939-6eed-4bf7-980f-fd6f66a9dbaf",
"db_language_id": "450ed488-1b0f-46ca-b938-5567504531f9",
"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": "2024-04-22T01:49:39.8830944+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5457817a-f073-4b92-bdaf-596c218b183d",
"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": "bf776183-5340-4bc0-99be-1eef83d30f71",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-04-22T01:49:39.8830944+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "60e2e391-c050-49ed-ae43-78605666f761"
},
"suggested_date_start": "2024-04-22T01:49:39.8830944+00:00",
"skill_id": "e303f321-2804-4e36-a4fd-b3043f2fff73",
"skill_code": "sample string 32",
"skill": {
"id": "3fbae85c-4b9c-43a7-a63c-ac92f0a2c46f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7d04193d-c93c-4142-90d8-35f17e0093dd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "14179e2a-512e-4e02-9246-0f2a41fdce38",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8b7fdcb-77ca-46d9-b0ad-98bce776c473",
"db_currency_id": "b58ce939-6eed-4bf7-980f-fd6f66a9dbaf",
"db_language_id": "450ed488-1b0f-46ca-b938-5567504531f9",
"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": "2024-04-22T01:49:39.8830944+00:00"
},
"modified_dateutc": "2024-04-22T01:49:39.8830944+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7c5d5b58-ba72-45f6-9f89-2f9773fc34a6",
"date_reported_by_company": "2024-04-22T01:49:39.8830944+00:00",
"id2": 36,
"company_id": "5ee18ade-4578-4e82-8e01-78aa10097a56",
"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": "631680cf-8559-4b0d-9194-3159898123f4",
"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": "2024-04-22T01:49:39.8830944+00:00"
},
"work_instruction_details_id": "f84d6e12-40bd-4224-b406-aae1ebbbe321",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "11086bfd-913a-4019-9631-0deeeeefbe51",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4ff6d1eb-a3cb-4f99-b47f-71e7df4105bb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-04-22T01:49:39.8830944+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": "958b985e-c3d7-4102-ad8e-19d56eff64f6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-04-22T01:49:39.8830944+00:00"
}