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": "92f24470-4587-4fff-a5e7-f8294ef036ef",
"jobs_id": "d50a6031-32d4-42b9-a72d-af9e0b07260b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "160187fa-c9f5-4715-985d-2689b0ffe12e",
"_parent_id": "9f1d2df5-cff5-4e5e-98a2-97e8b59a43e3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f7c2d5ca-2083-4c1a-aa0d-3592f7e481d7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0c8c844d-36fc-4adc-b4f6-1cc9233ee9d8",
"_parent_id": "cf3efdbb-e3fe-4202-b933-c0eb7e544c50",
"root_parent_id": "1a0d6c60-f07f-4646-9ebd-42a444dfa961",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2815309b-f8f9-4eb3-a7c1-2c31faf927ba",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ff7f44c8-1856-4d2c-bcdb-3b39b52084c6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4d1f9815-c067-4b38-b735-4c1e256162d7",
"_parent_code": "sample string 6",
"sales_organization_id": "6ef07ee0-5a96-41fa-a95e-ef59e3e373f5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cb421c6f-903b-423e-9ab9-86cc66367dda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "482952e4-0f65-41b9-9dfe-ab003034ea00",
"db_currency_id": "66276660-8a77-4aa4-881a-99bdb3b35911",
"db_language_id": "f4009cb8-6a88-4ce5-a5ff-4dc6ef6e5360",
"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-20T16:02:07.2973989+00:00"
},
"modified_dateutc": "2024-04-20T16:02:07.2973989+00:00"
},
"equipment_model_id": "a22b4327-dc7a-47cb-a63c-9c72afeff310",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "842305a9-50ce-427a-b824-7b5f0dfa2cb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "899a2069-ca4a-44a6-ad61-9f2b0d062093",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5707e5c4-5dd7-453b-9278-59646615c080",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d0d6535c-d8b1-441b-b5da-947d2a71a194",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cb421c6f-903b-423e-9ab9-86cc66367dda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "482952e4-0f65-41b9-9dfe-ab003034ea00",
"db_currency_id": "66276660-8a77-4aa4-881a-99bdb3b35911",
"db_language_id": "f4009cb8-6a88-4ce5-a5ff-4dc6ef6e5360",
"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-20T16:02:07.2973989+00:00"
},
"modified_dateutc": "2024-04-20T16:02:07.2973989+00:00"
},
"equipment_family_id": "d98b50b6-76e7-4451-af64-4f467d09ab43",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ff7f44c8-1856-4d2c-bcdb-3b39b52084c6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4d1f9815-c067-4b38-b735-4c1e256162d7",
"_parent_code": "sample string 6",
"sales_organization_id": "6ef07ee0-5a96-41fa-a95e-ef59e3e373f5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cb421c6f-903b-423e-9ab9-86cc66367dda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "482952e4-0f65-41b9-9dfe-ab003034ea00",
"db_currency_id": "66276660-8a77-4aa4-881a-99bdb3b35911",
"db_language_id": "f4009cb8-6a88-4ce5-a5ff-4dc6ef6e5360",
"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-20T16:02:07.2973989+00:00"
},
"modified_dateutc": "2024-04-20T16:02:07.2973989+00:00"
},
"date_in_production_since": "2024-04-20T16:02:07.2973989+00:00",
"date_out_of_production_since": "2024-04-20T16:02:07.2973989+00:00",
"date_end_support": "2024-04-20T16:02:07.2973989+00:00",
"sales_organization_id": "ad9ae3a4-5932-4888-891d-ccfb0bfbbba1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cb421c6f-903b-423e-9ab9-86cc66367dda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "482952e4-0f65-41b9-9dfe-ab003034ea00",
"db_currency_id": "66276660-8a77-4aa4-881a-99bdb3b35911",
"db_language_id": "f4009cb8-6a88-4ce5-a5ff-4dc6ef6e5360",
"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-20T16:02:07.2973989+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-20T16:02:07.2973989+00:00"
},
"project_status_id": "45fb9f62-e4a3-4292-a30e-0cec7ddbe4df",
"project_status_code": "sample string 10",
"project_status": {
"id": "49df5244-9913-4047-82e2-1f7dca0b6038",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "48e31c79-63f0-44c1-94e1-0e71b874bf9d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cb421c6f-903b-423e-9ab9-86cc66367dda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "482952e4-0f65-41b9-9dfe-ab003034ea00",
"db_currency_id": "66276660-8a77-4aa4-881a-99bdb3b35911",
"db_language_id": "f4009cb8-6a88-4ce5-a5ff-4dc6ef6e5360",
"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-20T16:02:07.2973989+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-20T16:02:07.2973989+00:00"
},
"company_id": "95a3a944-c29d-4ae1-aaf4-84d45384728c",
"company_code": "sample string 12",
"db_address_id": "b08eb297-201a-4746-a323-1405de5118a9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "54297cbc-9356-45d2-8ee8-388c92eeb72e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "146961ef-976f-42a3-88d8-1a11f0d2324a",
"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-20T16:02:07.2973989+00:00",
"date_create": "2024-04-20T16:02:07.2973989+00:00",
"date_update": "2024-04-20T16:02:07.2973989+00:00",
"updated_by_user_id": "44bd6ca5-00be-4798-bb83-30908263143e",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-04-20T16:02:07.2973989+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-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-04-20T16:02:07.2973989+00:00",
"date_last_job": "2024-04-20T16:02:07.2973989+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-04-20T16:02:07.2973989+00:00",
"modified_dateutc": "2024-04-20T16:02:07.2973989+00:00",
"is_mobile_installation": true
},
"job_type_id": "6a0ba8b8-f57c-4c5a-8f2e-682074009761",
"job_type_code": "sample string 7",
"job_type": {
"id": "46f224ff-6b65-4a2b-8846-3d758fb540e2",
"name": "sample string 2",
"sales_organization_id": "53352709-ab09-4ff6-bb47-32308bc3fda1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-04-20T16:02:07.2973989+00:00",
"code": "sample string 7"
},
"job_priority_id": "ba2e1d35-1d73-47e8-b2f8-d6f919a88fb0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4a2d3695-ee07-44c0-9ccc-c4000e83d940",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "31a8247e-e83f-4ea3-8fee-2c4a8eb9eec4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cb421c6f-903b-423e-9ab9-86cc66367dda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "482952e4-0f65-41b9-9dfe-ab003034ea00",
"db_currency_id": "66276660-8a77-4aa4-881a-99bdb3b35911",
"db_language_id": "f4009cb8-6a88-4ce5-a5ff-4dc6ef6e5360",
"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-20T16:02:07.2973989+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-20T16:02:07.2973989+00:00"
},
"job_status_id": "f4849172-1813-43c6-bc83-5d9e6940509c",
"job_status_code": "sample string 11",
"db_address_id": "ae0e5324-9532-4ce7-8c5d-b7ac53e20cda",
"contact_id": "d436d4ca-d8f7-4c71-8c35-9e20a5b17a31",
"requested_by_company_id": "c31a3250-b208-4f74-bbd4-76a42d407953",
"requested_by_contact_id": "aff22012-6a2f-4387-809b-22a7b0bbb21d",
"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-20T16:02:07.2973989+00:00",
"due_date": "2024-04-20T16:02:07.2973989+00:00",
"date_create": "2024-04-20T16:02:07.2973989+00:00",
"date_update": "2024-04-20T16:02:07.2973989+00:00",
"date_closed": "2024-04-20T16:02:07.2973989+00:00",
"suggested_user_id": "f0327b94-d099-46dc-9a60-7dca660e4ed2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "611904f1-924c-45ea-b9b8-3ebbc273289a",
"db_language_id": "27d84678-f3aa-4963-b158-90b55100ad7a",
"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-20T16:02:07.2973989+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8d4feba2-d54a-40bf-bda6-4e7fbd06d4aa",
"sales_organization": {
"id": "cb421c6f-903b-423e-9ab9-86cc66367dda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "482952e4-0f65-41b9-9dfe-ab003034ea00",
"db_currency_id": "66276660-8a77-4aa4-881a-99bdb3b35911",
"db_language_id": "f4009cb8-6a88-4ce5-a5ff-4dc6ef6e5360",
"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-20T16:02:07.2973989+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "74d20259-fa69-4306-9352-c5c979398094",
"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": "73ae0c93-e31e-41a3-846e-425bb4b80360",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-04-20T16:02:07.2973989+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c669c5dc-52c8-4f8f-98c3-8d9df62243f5"
},
"suggested_date_start": "2024-04-20T16:02:07.2973989+00:00",
"skill_id": "d5666496-6755-42b1-b25e-7f988d65cea4",
"skill_code": "sample string 32",
"skill": {
"id": "911f1f96-cf97-4ff4-93d2-681d7b7231ff",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f692ea90-1a67-45f0-8fbe-fd493b2fbe76",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cb421c6f-903b-423e-9ab9-86cc66367dda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "482952e4-0f65-41b9-9dfe-ab003034ea00",
"db_currency_id": "66276660-8a77-4aa4-881a-99bdb3b35911",
"db_language_id": "f4009cb8-6a88-4ce5-a5ff-4dc6ef6e5360",
"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-20T16:02:07.2973989+00:00"
},
"modified_dateutc": "2024-04-20T16:02:07.2973989+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6af20752-0b16-40a9-acbb-a7d6b85b6342",
"date_reported_by_company": "2024-04-20T16:02:07.2973989+00:00",
"id2": 36,
"company_id": "befd27b5-cb69-462d-ba20-abe671c4e244",
"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": "3b44fcfb-97c9-43f5-a4d7-a07020679926",
"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-20T16:02:07.2973989+00:00"
},
"work_instruction_details_id": "87c2eede-07c4-4245-b20e-cf26d83baab9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4c016371-8272-4fa5-80a3-4978dfc63715",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b6cca19e-51fa-4346-94cf-eeb84d64f0a3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-04-20T16:02:07.2973989+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": "2995ded0-4285-4ab6-a662-9fce18baf183",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-04-20T16:02:07.2973989+00:00"
}