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": "77c66b8c-c07f-4b5f-9777-380d36cc95da",
"jobs_id": "df0164ca-c2d2-4cc6-b942-1a0f09a39781",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "58960c81-b7a2-4734-b48b-2a90269d2788",
"_parent_id": "3c60c40e-1ccd-4db8-9ebc-77577e1e5fbd",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4e181405-ab38-4f36-9a2d-58134ff1c2ce",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6fe2e321-d52a-483d-bd9a-278074f866aa",
"_parent_id": "6b238011-baf5-43bf-989c-f21cfe584917",
"root_parent_id": "07e8e8c4-3190-4397-9c12-0f82ea935c6d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "77e89332-b2b3-4f27-991e-652abf81dc05",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "502d2e1c-2892-4ace-9598-af53f92a378d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2fbb6512-ca84-4b41-a0e2-99fcfd591437",
"_parent_code": "sample string 6",
"sales_organization_id": "a09d7d78-4b90-4c4a-863f-9b9bdf891a99",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fc570c94-ad2c-48f6-9ded-42d8cff6d1d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5101fca5-49b1-4626-9553-495c2b1c1a84",
"db_currency_id": "6f683f96-f8e3-4554-916d-c790c0b526f2",
"db_language_id": "5add4a7d-fda2-46f4-abe0-1bbf1ef06743",
"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": "2025-01-22T01:08:27.2380466+00:00"
},
"modified_dateutc": "2025-01-22T01:08:27.2380466+00:00"
},
"equipment_model_id": "330d21da-44bd-4f6a-9efc-929026b18faf",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "40cea064-1711-48a2-8296-b3668032e31a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bd54cbe2-95ba-4953-83fb-a94b858925ca",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e55627d8-20a6-411c-97e9-9f2ac0bf5381",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7d87a579-5da3-41c8-afc3-1fbfb573aa25",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fc570c94-ad2c-48f6-9ded-42d8cff6d1d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5101fca5-49b1-4626-9553-495c2b1c1a84",
"db_currency_id": "6f683f96-f8e3-4554-916d-c790c0b526f2",
"db_language_id": "5add4a7d-fda2-46f4-abe0-1bbf1ef06743",
"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": "2025-01-22T01:08:27.2380466+00:00"
},
"modified_dateutc": "2025-01-22T01:08:27.2380466+00:00"
},
"equipment_family_id": "f4cb6fa5-322c-43f7-aaa4-17ca566d891f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "502d2e1c-2892-4ace-9598-af53f92a378d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2fbb6512-ca84-4b41-a0e2-99fcfd591437",
"_parent_code": "sample string 6",
"sales_organization_id": "a09d7d78-4b90-4c4a-863f-9b9bdf891a99",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fc570c94-ad2c-48f6-9ded-42d8cff6d1d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5101fca5-49b1-4626-9553-495c2b1c1a84",
"db_currency_id": "6f683f96-f8e3-4554-916d-c790c0b526f2",
"db_language_id": "5add4a7d-fda2-46f4-abe0-1bbf1ef06743",
"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": "2025-01-22T01:08:27.2380466+00:00"
},
"modified_dateutc": "2025-01-22T01:08:27.2380466+00:00"
},
"date_in_production_since": "2025-01-22T01:08:27.2380466+00:00",
"date_out_of_production_since": "2025-01-22T01:08:27.2380466+00:00",
"date_end_support": "2025-01-22T01:08:27.2380466+00:00",
"sales_organization_id": "5284aa18-8351-4990-abce-996933de5bef",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fc570c94-ad2c-48f6-9ded-42d8cff6d1d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5101fca5-49b1-4626-9553-495c2b1c1a84",
"db_currency_id": "6f683f96-f8e3-4554-916d-c790c0b526f2",
"db_language_id": "5add4a7d-fda2-46f4-abe0-1bbf1ef06743",
"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": "2025-01-22T01:08:27.2380466+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": "2025-01-22T01:08:27.2523053+00:00"
},
"project_status_id": "0d7db85e-de24-4b8f-8d17-396132688848",
"project_status_code": "sample string 10",
"project_status": {
"id": "60003dff-2e83-4332-9a25-daa95eda4dea",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "558e206e-cff4-48c3-8ef2-29f258e7e392",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fc570c94-ad2c-48f6-9ded-42d8cff6d1d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5101fca5-49b1-4626-9553-495c2b1c1a84",
"db_currency_id": "6f683f96-f8e3-4554-916d-c790c0b526f2",
"db_language_id": "5add4a7d-fda2-46f4-abe0-1bbf1ef06743",
"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": "2025-01-22T01:08:27.2380466+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-01-22T01:08:27.2523053+00:00"
},
"company_id": "f5121bca-0ec9-4315-a9fd-ab6309e0eb82",
"company_code": "sample string 12",
"db_address_id": "093348c8-93ba-4c41-a18a-63fa2e1bcaff",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2f3ef0cd-c14f-4e6e-9a4d-b49f0196d316",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3416d70e-cc8d-4b80-ae1e-8080320af9c0",
"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": "2025-01-22T01:08:27.2523053+00:00",
"date_create": "2025-01-22T01:08:27.2523053+00:00",
"date_update": "2025-01-22T01:08:27.2523053+00:00",
"updated_by_user_id": "965ffb56-a990-47b2-a9e8-09e80af04829",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-01-22T01:08:27.2523053+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": "2025-01-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-01-22T01:08:27.2523053+00:00",
"date_last_job": "2025-01-22T01:08:27.2523053+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-01-22T01:08:27.2523053+00:00",
"modified_dateutc": "2025-01-22T01:08:27.2523053+00:00",
"is_mobile_installation": true
},
"job_type_id": "0589638b-c452-45a3-a497-ac16a6b3647b",
"job_type_code": "sample string 7",
"job_type": {
"id": "58738150-a5b0-4670-bb2b-ad1d83bbf69e",
"name": "sample string 2",
"sales_organization_id": "fe621710-ff44-489a-99c9-ab6644a5ecc2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-01-22T01:08:27.2523053+00:00",
"code": "sample string 7"
},
"job_priority_id": "4ac9e45e-613b-4d8c-89e5-dee14577f5e1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "65dc59db-827d-4179-9896-bf202c63c32f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d4df8db6-dce2-4066-bd92-e4f3cdd0a2c5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fc570c94-ad2c-48f6-9ded-42d8cff6d1d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5101fca5-49b1-4626-9553-495c2b1c1a84",
"db_currency_id": "6f683f96-f8e3-4554-916d-c790c0b526f2",
"db_language_id": "5add4a7d-fda2-46f4-abe0-1bbf1ef06743",
"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": "2025-01-22T01:08:27.2380466+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-01-22T01:08:27.2523053+00:00"
},
"job_status_id": "7d18f141-3ca1-4f92-865d-71d8d5d1e17f",
"job_status_code": "sample string 11",
"db_address_id": "c83436ee-b661-4f66-ad16-630df8a04954",
"contact_id": "b9327794-7d4c-41ac-953b-3f1b79668cf5",
"requested_by_company_id": "a134023b-e2c3-47d9-bf3c-d7705d326c08",
"requested_by_contact_id": "87811850-1441-4c90-b3f6-eaf33334eb13",
"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": "2025-01-22T01:08:27.2523053+00:00",
"due_date": "2025-01-22T01:08:27.2523053+00:00",
"date_create": "2025-01-22T01:08:27.2523053+00:00",
"date_update": "2025-01-22T01:08:27.2523053+00:00",
"date_closed": "2025-01-22T01:08:27.2523053+00:00",
"suggested_user_id": "0d7b9cc6-3fcf-47ba-b03d-a188edae7e32",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f9fc9cc5-9478-4c0f-8ac0-aefceb69d38d",
"db_language_id": "e0b0afa8-71d7-4b91-896b-899ecccd7836",
"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": "2025-01-22T01:08:27.2523053+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "62f135c3-a89a-4370-a7a7-8d44704c3381",
"sales_organization": {
"id": "fc570c94-ad2c-48f6-9ded-42d8cff6d1d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5101fca5-49b1-4626-9553-495c2b1c1a84",
"db_currency_id": "6f683f96-f8e3-4554-916d-c790c0b526f2",
"db_language_id": "5add4a7d-fda2-46f4-abe0-1bbf1ef06743",
"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": "2025-01-22T01:08:27.2380466+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f4394dc7-6e10-48bc-ab36-8f3b3b530b01",
"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": "6f53fadb-71d9-4d65-80bb-e452434c485d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-01-22T01:08:27.2523053+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "020feb0c-a7a9-48ee-b7ba-dd7a056d10ed"
},
"suggested_date_start": "2025-01-22T01:08:27.2523053+00:00",
"skill_id": "cc9eb6aa-3fdf-47e4-97e5-ee3be6bb8a08",
"skill_code": "sample string 32",
"skill": {
"id": "f649a332-8c56-47ed-9558-2db6b985b760",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8552e0f7-3dbb-4878-a593-1b0b3dadaa3c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fc570c94-ad2c-48f6-9ded-42d8cff6d1d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5101fca5-49b1-4626-9553-495c2b1c1a84",
"db_currency_id": "6f683f96-f8e3-4554-916d-c790c0b526f2",
"db_language_id": "5add4a7d-fda2-46f4-abe0-1bbf1ef06743",
"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": "2025-01-22T01:08:27.2380466+00:00"
},
"modified_dateutc": "2025-01-22T01:08:27.2523053+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5bd789ad-b783-4c5e-a795-ca24e1edc16b",
"date_reported_by_company": "2025-01-22T01:08:27.2523053+00:00",
"id2": 36,
"company_id": "033f738f-ca1d-4a0e-8803-92ecf432b7e9",
"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": "4dae1c97-567d-41a9-a8b9-80a5c41c7e18",
"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": "2025-01-22T01:08:27.2523053+00:00"
},
"work_instruction_details_id": "ce7d1eef-937f-410b-96f3-d80effcbadaa",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2fc0a333-9e8a-44b9-8812-20f552986f80",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "11d7fe75-3c17-46dd-a690-8315e0f34f1c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-01-22T01:08:27.2523053+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": "5a91d9be-1c51-4818-ba88-99a854008ab8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-01-22T01:08:27.2523053+00:00"
}