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": "38a9abf2-ea1a-4f72-871c-24c09dc49d23",
"jobs_id": "1cf9f0ff-5d50-4155-bef2-1332f8bedb88",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bf42e14f-2520-4380-98b5-1ac0df84f3b5",
"_parent_id": "f8488eac-9475-4227-b865-d5ecab746b63",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8e776f32-1165-41a5-89c8-b81832e17c57",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1c33046a-f147-4343-bb9d-33288e8ec627",
"_parent_id": "b3c23cf0-fd4a-40da-b5ae-c58c8f589a11",
"root_parent_id": "624b1cab-a99e-4c64-8cd4-dda26854b72d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "310b01b1-d7f6-4cba-acd3-a1a1dfa02df9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9f05e20a-579c-410f-b725-252dc424acbf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "19dbc9a8-2adc-4f6b-ab50-d8322b5de5b0",
"_parent_code": "sample string 6",
"sales_organization_id": "a1fff438-204d-4711-b74a-28bb594a95d6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "34082815-53b7-45f5-93c8-f99e38fbea00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71b40d20-afc3-4f19-a757-8d182a73cdab",
"db_currency_id": "896d10b7-d919-4693-be0e-ac1400fd22cf",
"db_language_id": "045cc5c8-1dca-4967-a3c7-92ddabd34c9c",
"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-12-06T05:08:57.3671447+01:00"
},
"modified_dateutc": "2022-12-06T05:08:57.3671447+01:00"
},
"equipment_model_id": "dff94dd0-1cf7-4a2c-8a25-9727d80f16a2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "40c33e2e-52be-484c-bcd0-291941beced1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fcb1e2ca-5985-4873-8d7b-f76efa17d36c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c854bb45-0212-4616-a9ba-85d275ed1a73",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6f34252c-02ec-4b9d-86c9-87d1eb66c9df",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "34082815-53b7-45f5-93c8-f99e38fbea00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71b40d20-afc3-4f19-a757-8d182a73cdab",
"db_currency_id": "896d10b7-d919-4693-be0e-ac1400fd22cf",
"db_language_id": "045cc5c8-1dca-4967-a3c7-92ddabd34c9c",
"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-12-06T05:08:57.3671447+01:00"
},
"modified_dateutc": "2022-12-06T05:08:57.3671447+01:00"
},
"equipment_family_id": "2cb82529-233d-4555-a2eb-cd09a43967dc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9f05e20a-579c-410f-b725-252dc424acbf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "19dbc9a8-2adc-4f6b-ab50-d8322b5de5b0",
"_parent_code": "sample string 6",
"sales_organization_id": "a1fff438-204d-4711-b74a-28bb594a95d6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "34082815-53b7-45f5-93c8-f99e38fbea00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71b40d20-afc3-4f19-a757-8d182a73cdab",
"db_currency_id": "896d10b7-d919-4693-be0e-ac1400fd22cf",
"db_language_id": "045cc5c8-1dca-4967-a3c7-92ddabd34c9c",
"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-12-06T05:08:57.3671447+01:00"
},
"modified_dateutc": "2022-12-06T05:08:57.3671447+01:00"
},
"date_in_production_since": "2022-12-06T05:08:57.3671447+01:00",
"date_out_of_production_since": "2022-12-06T05:08:57.3671447+01:00",
"date_end_support": "2022-12-06T05:08:57.3671447+01:00",
"sales_organization_id": "4ba7fd18-8957-46f7-94ab-e165752d605d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "34082815-53b7-45f5-93c8-f99e38fbea00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71b40d20-afc3-4f19-a757-8d182a73cdab",
"db_currency_id": "896d10b7-d919-4693-be0e-ac1400fd22cf",
"db_language_id": "045cc5c8-1dca-4967-a3c7-92ddabd34c9c",
"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-12-06T05:08:57.3671447+01: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-12-06T05:08:57.3671447+01:00"
},
"project_status_id": "ce37e9c0-9d97-4f90-a8ef-af420f6bb39a",
"project_status_code": "sample string 10",
"project_status": {
"id": "9c23939d-91b1-4829-966e-447f68a38778",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a0c90925-558c-4b60-b154-2bc1b084eef7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34082815-53b7-45f5-93c8-f99e38fbea00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71b40d20-afc3-4f19-a757-8d182a73cdab",
"db_currency_id": "896d10b7-d919-4693-be0e-ac1400fd22cf",
"db_language_id": "045cc5c8-1dca-4967-a3c7-92ddabd34c9c",
"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-12-06T05:08:57.3671447+01:00"
},
"code": "sample string 7",
"modified_dateutc": "2022-12-06T05:08:57.3671447+01:00"
},
"company_id": "f5453df3-d34b-4b96-9d74-21a9cbea6d13",
"company_code": "sample string 12",
"db_address_id": "64ca242f-3612-406b-8855-b1dd2c50ebbd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "daedbce5-16bb-4329-932d-e242d850d0b4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b0d1d2bd-7b0d-48c5-aae3-591e3ca741c1",
"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-12-06T05:08:57.3671447+01:00",
"date_create": "2022-12-06T05:08:57.3671447+01:00",
"date_update": "2022-12-06T05:08:57.3671447+01:00",
"updated_by_user_id": "241fdb01-f84f-4f0a-bb8d-01bd8fb03b27",
"customer_reference": "sample string 28",
"warranty_date_until": "2022-12-06T05:08:57.3671447+01: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-12-06T00:00:00+01:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2022-12-06T05:08:57.3671447+01:00",
"date_last_job": "2022-12-06T05:08:57.3671447+01:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2022-12-06T05:08:57.3671447+01:00",
"modified_dateutc": "2022-12-06T05:08:57.3671447+01:00",
"is_mobile_installation": true
},
"job_type_id": "c5597ca7-68f7-463d-b18a-52c980df9192",
"job_type_code": "sample string 7",
"job_type": {
"id": "c93c4c1e-11a6-4b49-8905-07bf10692f67",
"name": "sample string 2",
"sales_organization_id": "3546c837-09ce-4a93-98f8-07c162b3fded",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2022-12-06T05:08:57.3671447+01:00",
"code": "sample string 7"
},
"job_priority_id": "801fa04f-e207-49d1-b57f-a03f25c06ef0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bb6378a8-c3e4-47e5-b7b2-119d7d4a8299",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "935fa947-e2d1-4559-b62b-c15a1396e14f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34082815-53b7-45f5-93c8-f99e38fbea00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71b40d20-afc3-4f19-a757-8d182a73cdab",
"db_currency_id": "896d10b7-d919-4693-be0e-ac1400fd22cf",
"db_language_id": "045cc5c8-1dca-4967-a3c7-92ddabd34c9c",
"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-12-06T05:08:57.3671447+01:00"
},
"code": "sample string 7",
"modified_dateutc": "2022-12-06T05:08:57.3671447+01:00"
},
"job_status_id": "c54a4d52-32a0-483b-a08d-7e340e4b8e80",
"job_status_code": "sample string 11",
"db_address_id": "fb1def26-0785-442c-944e-f9b0bec481ae",
"contact_id": "78b65dd5-0997-43cf-b6e3-f018f34a23c5",
"requested_by_company_id": "e1925f7f-0bc7-4dca-92fb-ad43442bc42f",
"requested_by_contact_id": "df984c5c-78ff-4ccc-bc3c-aec7af77b799",
"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-12-06T05:08:57.3671447+01:00",
"due_date": "2022-12-06T05:08:57.3671447+01:00",
"date_create": "2022-12-06T05:08:57.3671447+01:00",
"date_update": "2022-12-06T05:08:57.3671447+01:00",
"date_closed": "2022-12-06T05:08:57.3671447+01:00",
"suggested_user_id": "0c1bf5be-51fc-40b2-9903-47c3a78b2f03",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "eea9c943-7456-46b8-9473-c5adbef05c6f",
"db_language_id": "4c1c760f-d808-4a6e-bda8-2f92d8d18972",
"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-12-06T05:08:57.3671447+01:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3bc1b2e0-c2b8-4682-add4-c3d57059c3de",
"sales_organization": {
"id": "34082815-53b7-45f5-93c8-f99e38fbea00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71b40d20-afc3-4f19-a757-8d182a73cdab",
"db_currency_id": "896d10b7-d919-4693-be0e-ac1400fd22cf",
"db_language_id": "045cc5c8-1dca-4967-a3c7-92ddabd34c9c",
"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-12-06T05:08:57.3671447+01:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5727aac9-ce6f-4889-8e57-673aebc6b081",
"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": "27288ae7-a8a3-4b0d-98a9-22b268b3e5a3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2022-12-06T05:08:57.3671447+01:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2bb638b8-6a54-47e2-92ca-24e1571db4e9"
},
"suggested_date_start": "2022-12-06T05:08:57.3671447+01:00",
"skill_id": "02ec3f2c-0ef0-4410-86a3-0e45a9c186ad",
"skill_code": "sample string 32",
"skill": {
"id": "b7cbb9ad-ac2d-4bc3-a959-da792d0a2d44",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3f730d85-475a-4a5b-89fa-4188e44d6d24",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34082815-53b7-45f5-93c8-f99e38fbea00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71b40d20-afc3-4f19-a757-8d182a73cdab",
"db_currency_id": "896d10b7-d919-4693-be0e-ac1400fd22cf",
"db_language_id": "045cc5c8-1dca-4967-a3c7-92ddabd34c9c",
"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-12-06T05:08:57.3671447+01:00"
},
"modified_dateutc": "2022-12-06T05:08:57.3671447+01:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "300d6409-3e61-4ab3-95cf-4bf9f3a142f6",
"date_reported_by_company": "2022-12-06T05:08:57.3671447+01:00",
"id2": 36,
"company_id": "4cf05676-d0ed-4dd4-828d-aebcbbdd7f5f",
"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": "45d72fab-0d05-4351-8cac-501b2793addb",
"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-12-06T05:08:57.3671447+01:00"
},
"work_instruction_details_id": "1579421c-9d9c-4a3f-8adf-9b2768fe63aa",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a2271f65-5abc-4450-96b6-1ded09e17076",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "884cf2a3-b790-4a3c-926f-6e45a9134e42",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2022-12-06T05:08:57.3671447+01: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": "e5f7392a-b7b4-4240-9144-62c91f25fe3c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2022-12-06T05:08:57.3671447+01:00"
}