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": "0bebe1a2-6116-4cb2-928f-e871b8b1367b",
"jobs_id": "fba39697-371d-49c3-a83f-da4d4edf1768",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f67315ec-e41e-458d-a1a9-533dd80e116a",
"_parent_id": "9ee68881-69ca-40af-88bb-0b6ee34eafc9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4e97c653-0617-41b6-be4b-21461db1f44e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a98add78-3f3b-4288-bdf5-e78a740cc7cd",
"_parent_id": "94d35397-7d2f-4933-8c67-9c6dfaabe866",
"root_parent_id": "a59d891e-fa69-4950-a45b-1f7ece591cc5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9e2cdae2-0e9a-4ef7-830c-6ee804c0b454",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6da13496-b36a-4b92-be4d-04726e1c4143",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "60469a3f-08c7-4dd4-adfe-b2bfaf7c49bf",
"_parent_code": "sample string 6",
"sales_organization_id": "178f5978-2e8a-4e85-ab9b-be5f8f313e5d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b018bc04-95b9-4672-8ba6-27d33f1a416a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c39cf450-7c6d-40d0-bae5-0997ff773c66",
"db_currency_id": "37966c12-5fa2-486b-ac39-28f9436afa89",
"db_language_id": "01042a0b-52c1-40d9-9dc7-f709685f35b9",
"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-07-20T07:31:45.6500099+00:00"
},
"modified_dateutc": "2024-07-20T07:31:45.6500099+00:00"
},
"equipment_model_id": "9d5511d4-3b85-40f0-99de-e9ba27b05927",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7d0e421d-4511-4209-8f8f-62246c3a54ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "13257d0e-c864-478d-8d57-ad43b09a9f98",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c6d3be3c-9722-4743-8236-5547d74a9d03",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a1a850d5-1a1c-434c-a678-f54924b26ccf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b018bc04-95b9-4672-8ba6-27d33f1a416a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c39cf450-7c6d-40d0-bae5-0997ff773c66",
"db_currency_id": "37966c12-5fa2-486b-ac39-28f9436afa89",
"db_language_id": "01042a0b-52c1-40d9-9dc7-f709685f35b9",
"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-07-20T07:31:45.6500099+00:00"
},
"modified_dateutc": "2024-07-20T07:31:45.6500099+00:00"
},
"equipment_family_id": "e8bf6cf6-b91b-4cd8-a43e-2dda69d8d9cb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6da13496-b36a-4b92-be4d-04726e1c4143",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "60469a3f-08c7-4dd4-adfe-b2bfaf7c49bf",
"_parent_code": "sample string 6",
"sales_organization_id": "178f5978-2e8a-4e85-ab9b-be5f8f313e5d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b018bc04-95b9-4672-8ba6-27d33f1a416a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c39cf450-7c6d-40d0-bae5-0997ff773c66",
"db_currency_id": "37966c12-5fa2-486b-ac39-28f9436afa89",
"db_language_id": "01042a0b-52c1-40d9-9dc7-f709685f35b9",
"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-07-20T07:31:45.6500099+00:00"
},
"modified_dateutc": "2024-07-20T07:31:45.6500099+00:00"
},
"date_in_production_since": "2024-07-20T07:31:45.6500099+00:00",
"date_out_of_production_since": "2024-07-20T07:31:45.6500099+00:00",
"date_end_support": "2024-07-20T07:31:45.6500099+00:00",
"sales_organization_id": "a7863fe1-70b6-49cc-9e26-8461a59bbef5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b018bc04-95b9-4672-8ba6-27d33f1a416a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c39cf450-7c6d-40d0-bae5-0997ff773c66",
"db_currency_id": "37966c12-5fa2-486b-ac39-28f9436afa89",
"db_language_id": "01042a0b-52c1-40d9-9dc7-f709685f35b9",
"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-07-20T07:31:45.6500099+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-07-20T07:31:45.6500099+00:00"
},
"project_status_id": "915b5420-1265-437b-a833-7ba10269fa83",
"project_status_code": "sample string 10",
"project_status": {
"id": "0097be2d-0b8d-4f1a-a079-4ca6fc3b02de",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cede96c9-2745-484d-a332-cbd9807c811f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b018bc04-95b9-4672-8ba6-27d33f1a416a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c39cf450-7c6d-40d0-bae5-0997ff773c66",
"db_currency_id": "37966c12-5fa2-486b-ac39-28f9436afa89",
"db_language_id": "01042a0b-52c1-40d9-9dc7-f709685f35b9",
"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-07-20T07:31:45.6500099+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-07-20T07:31:45.6500099+00:00"
},
"company_id": "6ba9b5b4-b641-46e3-94cb-e352d2919fc7",
"company_code": "sample string 12",
"db_address_id": "f179e57b-3159-43fa-94bd-192814a31368",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e3ed16de-6f6e-4cb4-b584-19094f68651f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "162e527e-62b9-4902-9a8f-33770380ac15",
"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-07-20T07:31:45.6500099+00:00",
"date_create": "2024-07-20T07:31:45.6500099+00:00",
"date_update": "2024-07-20T07:31:45.6500099+00:00",
"updated_by_user_id": "3be962df-0a90-4a74-b97a-fe60fd4cab4c",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-07-20T07:31:45.6500099+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-07-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-07-20T07:31:45.6500099+00:00",
"date_last_job": "2024-07-20T07:31:45.6500099+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-07-20T07:31:45.6500099+00:00",
"modified_dateutc": "2024-07-20T07:31:45.6500099+00:00",
"is_mobile_installation": true
},
"job_type_id": "f6abe797-b391-4d6e-847d-7c0e484ea197",
"job_type_code": "sample string 7",
"job_type": {
"id": "72fe5f4d-bb93-41ff-8328-f80f1f93c2a8",
"name": "sample string 2",
"sales_organization_id": "be235f40-1444-48e7-bfdb-9ce4022de766",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-07-20T07:31:45.6500099+00:00",
"code": "sample string 7"
},
"job_priority_id": "d07e5593-dae5-4672-8103-8ac688c9748c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "661021d3-abbb-4b9f-aa8c-6c6e7528ff5e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0fe3ebff-2659-4441-93ee-f9bddffe93cf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b018bc04-95b9-4672-8ba6-27d33f1a416a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c39cf450-7c6d-40d0-bae5-0997ff773c66",
"db_currency_id": "37966c12-5fa2-486b-ac39-28f9436afa89",
"db_language_id": "01042a0b-52c1-40d9-9dc7-f709685f35b9",
"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-07-20T07:31:45.6500099+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-07-20T07:31:45.6500099+00:00"
},
"job_status_id": "e919ee54-3360-406e-84c5-ab4dd9a7c4f7",
"job_status_code": "sample string 11",
"db_address_id": "f3caeb07-9776-4891-b939-7f2637d3a446",
"contact_id": "7e69c3eb-e0d5-465a-ad89-25a2a82baca7",
"requested_by_company_id": "251374c4-36f2-4013-b12c-9079c4769379",
"requested_by_contact_id": "b9041362-6e5d-44eb-8924-3b8595ad0f7d",
"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-07-20T07:31:45.6500099+00:00",
"due_date": "2024-07-20T07:31:45.6500099+00:00",
"date_create": "2024-07-20T07:31:45.6500099+00:00",
"date_update": "2024-07-20T07:31:45.6500099+00:00",
"date_closed": "2024-07-20T07:31:45.6500099+00:00",
"suggested_user_id": "1b32e6a7-f020-4b3a-8c6c-cfd2f5b9e3d2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9e283e41-d1bd-4a1a-a9c7-3e6344a04501",
"db_language_id": "0ce795e5-8b25-4410-8b35-ef669c8931e2",
"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-07-20T07:31:45.6500099+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7f298dfb-b722-446d-a6cf-7be297fdf5f4",
"sales_organization": {
"id": "b018bc04-95b9-4672-8ba6-27d33f1a416a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c39cf450-7c6d-40d0-bae5-0997ff773c66",
"db_currency_id": "37966c12-5fa2-486b-ac39-28f9436afa89",
"db_language_id": "01042a0b-52c1-40d9-9dc7-f709685f35b9",
"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-07-20T07:31:45.6500099+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8a12719b-93f0-48e0-be28-dc643e0a5656",
"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": "3f250b6d-3d70-483e-8302-ff687c95f859",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-07-20T07:31:45.6500099+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e3197239-e64b-4861-ad8d-888ecda369a9"
},
"suggested_date_start": "2024-07-20T07:31:45.6500099+00:00",
"skill_id": "38a73862-eb75-4409-84ba-2fd2249636c6",
"skill_code": "sample string 32",
"skill": {
"id": "8a0d1069-2e00-43ef-97e1-d08f5d2ba0aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9c600883-8a87-4682-bc89-0629c730f3dd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b018bc04-95b9-4672-8ba6-27d33f1a416a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c39cf450-7c6d-40d0-bae5-0997ff773c66",
"db_currency_id": "37966c12-5fa2-486b-ac39-28f9436afa89",
"db_language_id": "01042a0b-52c1-40d9-9dc7-f709685f35b9",
"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-07-20T07:31:45.6500099+00:00"
},
"modified_dateutc": "2024-07-20T07:31:45.6500099+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8d2e7a3b-1bcd-4910-9d15-2e10f02f4ab9",
"date_reported_by_company": "2024-07-20T07:31:45.6500099+00:00",
"id2": 36,
"company_id": "02c70f28-e4ab-48a3-8cd6-87865ac743b6",
"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": "1ec91984-b9af-4080-a1d0-9cc2c64c2167",
"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-07-20T07:31:45.6500099+00:00"
},
"work_instruction_details_id": "c89026ff-3cfc-4113-b0c9-efb4e72480bc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c106f5de-1353-4b47-876a-4b6f1106820a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "404cd9bf-3806-4b9f-873f-910b80c86aef",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-07-20T07:31:45.6500099+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": "fe704bdf-d295-46c7-8568-1843a525224a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-07-20T07:31:45.6500099+00:00"
}