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": "b039fd98-10a7-4878-852f-df8cd7865b3a",
"jobs_id": "9d6ca8d1-2b7a-47a6-8fc6-984f1e12efc2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "173bd521-d33c-4cad-921b-bcf03146e87c",
"_parent_id": "7f594070-a398-4fb5-8873-1764c9888a4c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "90021de4-04e9-4f24-9e2d-63af619991d8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c035aa37-0040-44fa-8cc9-8f8c49c144c9",
"_parent_id": "ad4341aa-29ed-4d72-9953-c84c8fddd244",
"root_parent_id": "f29b26e6-0b1a-4cd2-b770-3fecb59247fe",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e73d6125-56db-4497-913c-4726b4f2fdac",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fbdaa8e5-c1de-4c78-8fca-8fcdd431d2c8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "928d4948-e49b-4d4d-9385-3c12552b3b1a",
"_parent_code": "sample string 6",
"sales_organization_id": "f696344f-8639-46d7-9f5e-83c9e607bac6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "05afb229-6545-47a4-a44e-2d4a61b837d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c7f587-14fe-4c59-a148-4da2a3f92d35",
"db_currency_id": "e311aa9c-f0c2-41e4-a388-9b1c0b70790a",
"db_language_id": "9d33ef79-eb7a-4d44-b3f5-bf3ee53f49b3",
"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": "2023-09-20T02:22:17.7620768+00:00"
},
"modified_dateutc": "2023-09-20T02:22:17.7620768+00:00"
},
"equipment_model_id": "599a64b4-5812-40ff-8939-82c6f0aa6165",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "75bd2935-376c-47e7-9065-299905eff0cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "501c4d5e-223d-4249-a0c3-639f4ae54510",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "65608e7d-6c29-46e6-8929-0f6f8328da07",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "27125cd6-2741-464d-9141-0c9ca16a311f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "05afb229-6545-47a4-a44e-2d4a61b837d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c7f587-14fe-4c59-a148-4da2a3f92d35",
"db_currency_id": "e311aa9c-f0c2-41e4-a388-9b1c0b70790a",
"db_language_id": "9d33ef79-eb7a-4d44-b3f5-bf3ee53f49b3",
"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": "2023-09-20T02:22:17.7620768+00:00"
},
"modified_dateutc": "2023-09-20T02:22:17.7620768+00:00"
},
"equipment_family_id": "3ade71d1-58d4-420f-8e93-6f906e2eeb4b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fbdaa8e5-c1de-4c78-8fca-8fcdd431d2c8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "928d4948-e49b-4d4d-9385-3c12552b3b1a",
"_parent_code": "sample string 6",
"sales_organization_id": "f696344f-8639-46d7-9f5e-83c9e607bac6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "05afb229-6545-47a4-a44e-2d4a61b837d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c7f587-14fe-4c59-a148-4da2a3f92d35",
"db_currency_id": "e311aa9c-f0c2-41e4-a388-9b1c0b70790a",
"db_language_id": "9d33ef79-eb7a-4d44-b3f5-bf3ee53f49b3",
"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": "2023-09-20T02:22:17.7620768+00:00"
},
"modified_dateutc": "2023-09-20T02:22:17.7620768+00:00"
},
"date_in_production_since": "2023-09-20T02:22:17.7620768+00:00",
"date_out_of_production_since": "2023-09-20T02:22:17.7620768+00:00",
"date_end_support": "2023-09-20T02:22:17.7620768+00:00",
"sales_organization_id": "d8e5e0ae-8924-425b-84c6-8773141ac59a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "05afb229-6545-47a4-a44e-2d4a61b837d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c7f587-14fe-4c59-a148-4da2a3f92d35",
"db_currency_id": "e311aa9c-f0c2-41e4-a388-9b1c0b70790a",
"db_language_id": "9d33ef79-eb7a-4d44-b3f5-bf3ee53f49b3",
"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": "2023-09-20T02:22:17.7620768+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": "2023-09-20T02:22:17.7620768+00:00"
},
"project_status_id": "7381ce34-1781-4797-89b7-8a6ee3701e7c",
"project_status_code": "sample string 10",
"project_status": {
"id": "7b048a32-57b7-45eb-8c4a-ca9e2304e417",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6eb1faf1-0a20-4663-9e7f-9fed5996654f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "05afb229-6545-47a4-a44e-2d4a61b837d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c7f587-14fe-4c59-a148-4da2a3f92d35",
"db_currency_id": "e311aa9c-f0c2-41e4-a388-9b1c0b70790a",
"db_language_id": "9d33ef79-eb7a-4d44-b3f5-bf3ee53f49b3",
"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": "2023-09-20T02:22:17.7620768+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-09-20T02:22:17.7620768+00:00"
},
"company_id": "45e2e0f0-59e1-43d4-aa01-edf164f40f74",
"company_code": "sample string 12",
"db_address_id": "7b8cc87b-78f7-4818-ab80-8df7187d55c8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "66179fe7-a69a-451b-8dcc-82cccb30dcf3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0d1a47aa-d745-4e83-813f-45e238a7626c",
"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": "2023-09-20T02:22:17.7620768+00:00",
"date_create": "2023-09-20T02:22:17.7620768+00:00",
"date_update": "2023-09-20T02:22:17.7620768+00:00",
"updated_by_user_id": "00f6a095-146c-4ddc-b9f2-f0eb2916fe76",
"customer_reference": "sample string 28",
"warranty_date_until": "2023-09-20T02:22:17.7620768+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": "2023-09-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2023-09-20T02:22:17.7620768+00:00",
"date_last_job": "2023-09-20T02:22:17.7620768+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2023-09-20T02:22:17.7620768+00:00",
"modified_dateutc": "2023-09-20T02:22:17.7620768+00:00",
"is_mobile_installation": true
},
"job_type_id": "bcbc57e1-9869-48e7-be06-67c3ebfabf5c",
"job_type_code": "sample string 7",
"job_type": {
"id": "f2ec82be-86ce-4cec-b63f-d1d759b8bfd3",
"name": "sample string 2",
"sales_organization_id": "1e0bee45-a646-4def-99ad-ed679c68506b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2023-09-20T02:22:17.7620768+00:00",
"code": "sample string 7"
},
"job_priority_id": "9678c18b-4ddd-42d6-99a0-c64ca06cbd03",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "188d41a6-8f8c-47cc-ba9a-378776ebb0af",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "87337e34-1e6e-461a-a5f7-02c2286205e3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "05afb229-6545-47a4-a44e-2d4a61b837d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c7f587-14fe-4c59-a148-4da2a3f92d35",
"db_currency_id": "e311aa9c-f0c2-41e4-a388-9b1c0b70790a",
"db_language_id": "9d33ef79-eb7a-4d44-b3f5-bf3ee53f49b3",
"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": "2023-09-20T02:22:17.7620768+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-09-20T02:22:17.7620768+00:00"
},
"job_status_id": "c838f66d-4d51-4152-9763-50c64a1ae5ef",
"job_status_code": "sample string 11",
"db_address_id": "8701650a-59f7-47c2-a4ef-a76dc4594340",
"contact_id": "a6a301ea-e42a-4ece-860c-45e511589aaf",
"requested_by_company_id": "9b239037-e592-4426-bac7-b0150e5c7f71",
"requested_by_contact_id": "48039fa8-8801-4052-9059-5f2e884a556a",
"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": "2023-09-20T02:22:17.7620768+00:00",
"due_date": "2023-09-20T02:22:17.7620768+00:00",
"date_create": "2023-09-20T02:22:17.7620768+00:00",
"date_update": "2023-09-20T02:22:17.7620768+00:00",
"date_closed": "2023-09-20T02:22:17.7620768+00:00",
"suggested_user_id": "513f7a4a-4c4d-4b09-8530-63d573d047b0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a9df8a43-8da4-4702-94d6-cd2d6fbe31e0",
"db_language_id": "da8094a0-0c63-46ce-bba5-ba3b2524d7e3",
"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": "2023-09-20T02:22:17.7620768+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c6cda412-738d-4cc4-86ae-33cbe3cdc345",
"sales_organization": {
"id": "05afb229-6545-47a4-a44e-2d4a61b837d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c7f587-14fe-4c59-a148-4da2a3f92d35",
"db_currency_id": "e311aa9c-f0c2-41e4-a388-9b1c0b70790a",
"db_language_id": "9d33ef79-eb7a-4d44-b3f5-bf3ee53f49b3",
"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": "2023-09-20T02:22:17.7620768+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "91e1f23b-508c-4e48-b16e-cbd8fbf1de3e",
"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": "8064b92a-dca4-4376-bc1a-4efcd9d832ef",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2023-09-20T02:22:17.7620768+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1b42133f-c8e5-4761-9a1d-5140fde3936c"
},
"suggested_date_start": "2023-09-20T02:22:17.7620768+00:00",
"skill_id": "d7d77283-e41b-42da-9a84-992ac7f2b202",
"skill_code": "sample string 32",
"skill": {
"id": "44890023-c07b-4eb1-91ee-603606522618",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "99d8479a-3203-4809-91e4-019426d3f3fd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "05afb229-6545-47a4-a44e-2d4a61b837d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c7f587-14fe-4c59-a148-4da2a3f92d35",
"db_currency_id": "e311aa9c-f0c2-41e4-a388-9b1c0b70790a",
"db_language_id": "9d33ef79-eb7a-4d44-b3f5-bf3ee53f49b3",
"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": "2023-09-20T02:22:17.7620768+00:00"
},
"modified_dateutc": "2023-09-20T02:22:17.7620768+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "612b9c54-5164-497b-83bf-b67ab6c5fbb4",
"date_reported_by_company": "2023-09-20T02:22:17.7620768+00:00",
"id2": 36,
"company_id": "23c4338f-b7c5-4c18-b510-b210c00f797a",
"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": "eef2ec29-a342-4724-b525-26cdb040190a",
"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": "2023-09-20T02:22:17.7620768+00:00"
},
"work_instruction_details_id": "77cdba79-230d-4530-83a1-b9d102e7c99c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b6b1f0ac-07e7-496d-9d97-ca646aa02136",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "39fff3be-c83e-4ac6-9fac-d43cd0ec5714",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2023-09-20T02:22:17.7620768+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": "387f9236-a358-4297-881a-71de57f56902",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2023-09-20T02:22:17.7620768+00:00"
}