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": "dd38a93e-4214-419f-9099-a025051c9e7e",
"jobs_id": "e2884020-139a-4548-a7bf-0a6344076f9b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0324be0f-1d3f-499e-ad62-86126abbac86",
"_parent_id": "33154b34-e16b-47fe-aca9-0e77c42fbb5d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3ac5c6e6-a132-42e7-8ebc-655a3252fbd8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "31a521fa-146e-4cfe-bedb-b2f9ab5bfc9b",
"_parent_id": "09b07bb5-078b-4c05-9a5d-e79005929c82",
"root_parent_id": "3897bad4-bd90-4581-9f8a-9911b9354731",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "53d18479-7638-4af0-b104-b07c618b8ca5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "edfc8a41-b0df-49ae-a890-0b266fdf8e32",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d7bc7b04-cc15-4196-a849-31a7fe70adcc",
"_parent_code": "sample string 6",
"sales_organization_id": "0417eea9-1d9a-4260-a599-cc03fdeeb6b6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "415eb169-0933-44fe-84a8-abcbb629f885",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8dad4238-192c-4796-ad12-fc4045b710b8",
"db_currency_id": "a932f633-7305-4c50-8d57-4f35ab0fa1cd",
"db_language_id": "f0b00789-ef1c-4533-a87d-24c349cb7a12",
"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-11-21T09:57:00.6942745+00:00"
},
"modified_dateutc": "2024-11-21T09:57:00.6942745+00:00"
},
"equipment_model_id": "8a179a97-0668-402b-9fdd-e5f8080b4774",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d9451885-9fa3-4168-b532-7b61eeb8ecb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0afc139a-ed17-4a56-9ce6-536f3c8a4392",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8e84ab97-4f59-4b11-8fe4-83a610039485",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1662888c-b097-4326-8610-4cde890d8aee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "415eb169-0933-44fe-84a8-abcbb629f885",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8dad4238-192c-4796-ad12-fc4045b710b8",
"db_currency_id": "a932f633-7305-4c50-8d57-4f35ab0fa1cd",
"db_language_id": "f0b00789-ef1c-4533-a87d-24c349cb7a12",
"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-11-21T09:57:00.6942745+00:00"
},
"modified_dateutc": "2024-11-21T09:57:00.6942745+00:00"
},
"equipment_family_id": "b40f7fdb-069f-43bf-b458-ae61fb0a4490",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "edfc8a41-b0df-49ae-a890-0b266fdf8e32",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d7bc7b04-cc15-4196-a849-31a7fe70adcc",
"_parent_code": "sample string 6",
"sales_organization_id": "0417eea9-1d9a-4260-a599-cc03fdeeb6b6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "415eb169-0933-44fe-84a8-abcbb629f885",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8dad4238-192c-4796-ad12-fc4045b710b8",
"db_currency_id": "a932f633-7305-4c50-8d57-4f35ab0fa1cd",
"db_language_id": "f0b00789-ef1c-4533-a87d-24c349cb7a12",
"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-11-21T09:57:00.6942745+00:00"
},
"modified_dateutc": "2024-11-21T09:57:00.6942745+00:00"
},
"date_in_production_since": "2024-11-21T09:57:00.6942745+00:00",
"date_out_of_production_since": "2024-11-21T09:57:00.6942745+00:00",
"date_end_support": "2024-11-21T09:57:00.6942745+00:00",
"sales_organization_id": "21424e1b-ab26-497f-8fc0-8631d82ca126",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "415eb169-0933-44fe-84a8-abcbb629f885",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8dad4238-192c-4796-ad12-fc4045b710b8",
"db_currency_id": "a932f633-7305-4c50-8d57-4f35ab0fa1cd",
"db_language_id": "f0b00789-ef1c-4533-a87d-24c349cb7a12",
"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-11-21T09:57:00.6942745+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-11-21T09:57:00.6942745+00:00"
},
"project_status_id": "b682b28f-9f94-4167-b253-ee6dfe65b9d4",
"project_status_code": "sample string 10",
"project_status": {
"id": "9b729a31-0a8d-44ed-9567-d7fafa7ae35c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2bdf419e-c46c-45a1-a605-75bfaaaf5883",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "415eb169-0933-44fe-84a8-abcbb629f885",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8dad4238-192c-4796-ad12-fc4045b710b8",
"db_currency_id": "a932f633-7305-4c50-8d57-4f35ab0fa1cd",
"db_language_id": "f0b00789-ef1c-4533-a87d-24c349cb7a12",
"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-11-21T09:57:00.6942745+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-11-21T09:57:00.6942745+00:00"
},
"company_id": "306cc60b-47a3-4966-8f37-62a1cea5b01e",
"company_code": "sample string 12",
"db_address_id": "f75780b0-09fc-425b-9008-d4a01db568ef",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "498b387e-6805-4318-9f3e-fe0a19fd610d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c259829c-82fd-43a4-887a-4ab234152fe1",
"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-11-21T09:57:00.6942745+00:00",
"date_create": "2024-11-21T09:57:00.6942745+00:00",
"date_update": "2024-11-21T09:57:00.6942745+00:00",
"updated_by_user_id": "23c732c8-1215-422c-96e4-df93c877ac2d",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-11-21T09:57:00.6942745+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-11-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-11-21T09:57:00.6942745+00:00",
"date_last_job": "2024-11-21T09:57:00.6942745+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-11-21T09:57:00.6942745+00:00",
"modified_dateutc": "2024-11-21T09:57:00.6942745+00:00",
"is_mobile_installation": true
},
"job_type_id": "243c048f-7f96-4385-87e3-04acb29f09e4",
"job_type_code": "sample string 7",
"job_type": {
"id": "72554dde-4454-46b3-9b54-fbcbf7d172ed",
"name": "sample string 2",
"sales_organization_id": "226e83eb-4758-451d-b4c5-6a40324693a9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-11-21T09:57:00.6942745+00:00",
"code": "sample string 7"
},
"job_priority_id": "b54733e4-378c-44d8-a49d-0d1e0147314a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "02001000-134b-4e3f-a4e4-b5ce4ee053cb",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9b47fc46-1a84-4783-a709-b9c354142996",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "415eb169-0933-44fe-84a8-abcbb629f885",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8dad4238-192c-4796-ad12-fc4045b710b8",
"db_currency_id": "a932f633-7305-4c50-8d57-4f35ab0fa1cd",
"db_language_id": "f0b00789-ef1c-4533-a87d-24c349cb7a12",
"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-11-21T09:57:00.6942745+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-11-21T09:57:00.6942745+00:00"
},
"job_status_id": "28ae48f9-acc6-4159-9f50-2f790140f312",
"job_status_code": "sample string 11",
"db_address_id": "4a49c380-1d9c-426f-a9b9-24330c296a49",
"contact_id": "b85f8b2c-54fd-4aa2-a1bd-a3ef2dda579b",
"requested_by_company_id": "a57061ec-5cfc-4ed5-8760-fbfe58f7b9aa",
"requested_by_contact_id": "aea0f2d7-7035-470f-b6d8-c0ac3c2b204f",
"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-11-21T09:57:00.6942745+00:00",
"due_date": "2024-11-21T09:57:00.6942745+00:00",
"date_create": "2024-11-21T09:57:00.6942745+00:00",
"date_update": "2024-11-21T09:57:00.6942745+00:00",
"date_closed": "2024-11-21T09:57:00.6942745+00:00",
"suggested_user_id": "638c1d7d-2864-45b1-a999-af5d12934acc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5b18f3cd-29ab-4aee-892f-a99b3a8263a6",
"db_language_id": "026b40d9-22fa-4bbe-a27a-be83bd587f8b",
"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-11-21T09:57:00.6942745+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5fafbdd6-8178-4859-aac9-2f3321b9179f",
"sales_organization": {
"id": "415eb169-0933-44fe-84a8-abcbb629f885",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8dad4238-192c-4796-ad12-fc4045b710b8",
"db_currency_id": "a932f633-7305-4c50-8d57-4f35ab0fa1cd",
"db_language_id": "f0b00789-ef1c-4533-a87d-24c349cb7a12",
"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-11-21T09:57:00.6942745+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "aef5fd76-17b6-4d35-b410-1e7425a72b22",
"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": "62265ac9-6b8e-4dee-839c-9348f862d2d2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-11-21T09:57:00.6942745+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "51702032-7ae1-4bdb-9eac-512ba393463b"
},
"suggested_date_start": "2024-11-21T09:57:00.6942745+00:00",
"skill_id": "8e8e77da-164a-4503-8794-572b4d6d1e65",
"skill_code": "sample string 32",
"skill": {
"id": "cf6d18db-67e5-4260-b8c4-829d35fb7cf6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b9bd9748-e3e8-4432-beb7-888e3b978af5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "415eb169-0933-44fe-84a8-abcbb629f885",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8dad4238-192c-4796-ad12-fc4045b710b8",
"db_currency_id": "a932f633-7305-4c50-8d57-4f35ab0fa1cd",
"db_language_id": "f0b00789-ef1c-4533-a87d-24c349cb7a12",
"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-11-21T09:57:00.6942745+00:00"
},
"modified_dateutc": "2024-11-21T09:57:00.6942745+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ee97aba9-215f-442c-8e16-ccdf06d23eb8",
"date_reported_by_company": "2024-11-21T09:57:00.6942745+00:00",
"id2": 36,
"company_id": "49f5a264-9cfb-4dbf-b95a-9820bcd650b4",
"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": "ea3b2bba-2c21-4634-92f9-e1412743dec7",
"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-11-21T09:57:00.6942745+00:00"
},
"work_instruction_details_id": "3eeeb6f3-3f91-4e76-b877-39e278fa6573",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8b2b36a4-f8af-4bb7-a0dc-5dcd70ed6d42",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7c69bdfa-fc12-408f-90cd-b74ad6043c4a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-11-21T09:57:00.6942745+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": "91fc4308-1248-4118-9436-ceb2e9e61dd5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-11-21T09:57:00.6942745+00:00"
}