Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
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": "ea3c54aa-e192-4338-9246-c42c6a99deef",
"jobs_id": "5899b4f0-c0fc-4206-b1ed-e6d50e3bfccb",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "adac1c24-4045-4d54-9692-59347eaa4b65",
"_parent_id": "72561fb4-06b0-4814-b364-14f8e3ec170d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3a497f5c-2f8e-44d9-a856-c36850e4dd06",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e0feaab1-1e80-4892-9671-036376821d6d",
"_parent_id": "3465ac18-6632-41e5-b9fc-38ece9fc4ae2",
"root_parent_id": "3dd23823-5a6c-40b9-9210-df005201587f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "61b4f768-9f1c-49a9-9c94-8fcb9aa8f476",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4459be13-7768-4861-8e6c-24e02c5f6272",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b5fe54b7-c1dd-406b-a8fb-1d77c6e7dfd0",
"_parent_code": "sample string 6",
"sales_organization_id": "eaee1cfb-e463-421a-96c2-a205b6884900",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "47098098-7e85-4dcc-84fc-06ddb8b0a775",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72f566ea-64f6-4205-9ed3-17f804039d65",
"db_currency_id": "56aceb8d-abfa-4dd7-95d7-d5ca60c09da8",
"db_language_id": "749dc2b2-4586-42e6-b984-a37a89e6d5ae",
"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-03-28T12:38:02.8636083+00:00"
},
"modified_dateutc": "2025-03-28T12:38:02.8636083+00:00"
},
"equipment_model_id": "9771ae56-5c29-4d56-a0e9-c3fbc26a9028",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6a4509ca-9a41-4a69-a052-ea5196e02610",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "38818e37-2cf0-4a7f-9567-8176bb8f683b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3fdc3268-f0c4-4c9f-b2bc-3c6a44c07016",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "284f5d50-da2f-46cf-8643-7d16e2412db9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "47098098-7e85-4dcc-84fc-06ddb8b0a775",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72f566ea-64f6-4205-9ed3-17f804039d65",
"db_currency_id": "56aceb8d-abfa-4dd7-95d7-d5ca60c09da8",
"db_language_id": "749dc2b2-4586-42e6-b984-a37a89e6d5ae",
"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-03-28T12:38:02.8636083+00:00"
},
"modified_dateutc": "2025-03-28T12:38:02.8636083+00:00"
},
"equipment_family_id": "e2d18554-211b-4488-a224-c409acf3bd8b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4459be13-7768-4861-8e6c-24e02c5f6272",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b5fe54b7-c1dd-406b-a8fb-1d77c6e7dfd0",
"_parent_code": "sample string 6",
"sales_organization_id": "eaee1cfb-e463-421a-96c2-a205b6884900",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "47098098-7e85-4dcc-84fc-06ddb8b0a775",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72f566ea-64f6-4205-9ed3-17f804039d65",
"db_currency_id": "56aceb8d-abfa-4dd7-95d7-d5ca60c09da8",
"db_language_id": "749dc2b2-4586-42e6-b984-a37a89e6d5ae",
"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-03-28T12:38:02.8636083+00:00"
},
"modified_dateutc": "2025-03-28T12:38:02.8636083+00:00"
},
"date_in_production_since": "2025-03-28T12:38:02.8636083+00:00",
"date_out_of_production_since": "2025-03-28T12:38:02.8636083+00:00",
"date_end_support": "2025-03-28T12:38:02.8636083+00:00",
"sales_organization_id": "2cba6f9b-8737-499a-abed-f3bac51635ae",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "47098098-7e85-4dcc-84fc-06ddb8b0a775",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72f566ea-64f6-4205-9ed3-17f804039d65",
"db_currency_id": "56aceb8d-abfa-4dd7-95d7-d5ca60c09da8",
"db_language_id": "749dc2b2-4586-42e6-b984-a37a89e6d5ae",
"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-03-28T12:38:02.8636083+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-03-28T12:38:02.8636083+00:00"
},
"project_status_id": "d0ef9807-86e9-48f7-a525-b50f27b742a6",
"project_status_code": "sample string 10",
"project_status": {
"id": "6b4807a4-6a9b-48fa-a1d8-bfd6835d162d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2b07675e-8336-4787-b2ad-e1aa30853e55",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "47098098-7e85-4dcc-84fc-06ddb8b0a775",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72f566ea-64f6-4205-9ed3-17f804039d65",
"db_currency_id": "56aceb8d-abfa-4dd7-95d7-d5ca60c09da8",
"db_language_id": "749dc2b2-4586-42e6-b984-a37a89e6d5ae",
"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-03-28T12:38:02.8636083+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-28T12:38:02.8636083+00:00"
},
"company_id": "c2bc50f6-417a-40bc-90d5-4d3df4a6675a",
"company_code": "sample string 12",
"db_address_id": "26d4d540-e1de-4bb4-a828-5ca3d5a17e5e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d6855008-7ec1-4d17-bd35-9d6f6112452f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "36863f02-1336-4325-991f-157467d2871c",
"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-03-28T12:38:02.8636083+00:00",
"date_create": "2025-03-28T12:38:02.8636083+00:00",
"date_update": "2025-03-28T12:38:02.8636083+00:00",
"updated_by_user_id": "3fa36371-24b1-497c-9d08-34ef4b225db8",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-03-28T12:38:02.8636083+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-03-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-03-28T12:38:02.8636083+00:00",
"date_last_job": "2025-03-28T12:38:02.8636083+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-03-28T12:38:02.8636083+00:00",
"modified_dateutc": "2025-03-28T12:38:02.8636083+00:00",
"is_mobile_installation": true
},
"job_type_id": "e23540cf-a12e-42bb-af5b-2a4283751a3c",
"job_type_code": "sample string 7",
"job_type": {
"id": "deea7172-34b2-4dff-a57c-ed939f47e4cb",
"name": "sample string 2",
"sales_organization_id": "bc3b0e61-354d-46d7-a2dc-9ccb9cc58204",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-03-28T12:38:02.8636083+00:00",
"code": "sample string 7"
},
"job_priority_id": "de0ce0f9-d628-49eb-bf70-997c3f7cecd0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c3da1fcc-13c6-4fee-ba33-2b278ffddf81",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5882209f-06a9-46ad-b090-986f0d6b0ef2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "47098098-7e85-4dcc-84fc-06ddb8b0a775",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72f566ea-64f6-4205-9ed3-17f804039d65",
"db_currency_id": "56aceb8d-abfa-4dd7-95d7-d5ca60c09da8",
"db_language_id": "749dc2b2-4586-42e6-b984-a37a89e6d5ae",
"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-03-28T12:38:02.8636083+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-28T12:38:02.8636083+00:00"
},
"job_status_id": "9387a405-3918-4772-84ba-b7daa7f602ef",
"job_status_code": "sample string 11",
"db_address_id": "bec02bc8-bc92-4810-95b3-ecff6eb4c2c8",
"contact_id": "76c53da2-6490-43a0-acc2-bed2194e323f",
"requested_by_company_id": "bca9c43d-f0dc-41f5-910f-f0d92a871c54",
"requested_by_contact_id": "012f7b9e-0598-463f-ae18-0a4317f8659a",
"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-03-28T12:38:02.8636083+00:00",
"due_date": "2025-03-28T12:38:02.8636083+00:00",
"date_create": "2025-03-28T12:38:02.8636083+00:00",
"date_update": "2025-03-28T12:38:02.8636083+00:00",
"date_closed": "2025-03-28T12:38:02.8636083+00:00",
"suggested_user_id": "dc38572b-8d39-4657-bc5a-8f202a31a29f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "04aa0c47-8d4e-4450-8ad3-85f5dfaca3fc",
"db_language_id": "a81d6cbb-4354-40d7-b815-c765f19234a4",
"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-03-28T12:38:02.8636083+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "90bbd5bc-2691-4103-8aa3-45becccf0ca6",
"sales_organization": {
"id": "47098098-7e85-4dcc-84fc-06ddb8b0a775",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72f566ea-64f6-4205-9ed3-17f804039d65",
"db_currency_id": "56aceb8d-abfa-4dd7-95d7-d5ca60c09da8",
"db_language_id": "749dc2b2-4586-42e6-b984-a37a89e6d5ae",
"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-03-28T12:38:02.8636083+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "98d7abbf-b812-41de-96e0-193d514f8667",
"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": "8d42299a-6e37-4571-b401-b82088259770",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-03-28T12:38:02.8636083+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "912c8d74-f4ab-4baf-b545-1ca39b840c18"
},
"suggested_date_start": "2025-03-28T12:38:02.8636083+00:00",
"skill_id": "060bd152-90d9-4244-ab01-dc30d6f76c67",
"skill_code": "sample string 32",
"skill": {
"id": "2ef47902-5dcc-474e-9aac-963ed41f4e08",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "342ebd94-b9df-43fb-afb9-f4a590a69eef",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "47098098-7e85-4dcc-84fc-06ddb8b0a775",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72f566ea-64f6-4205-9ed3-17f804039d65",
"db_currency_id": "56aceb8d-abfa-4dd7-95d7-d5ca60c09da8",
"db_language_id": "749dc2b2-4586-42e6-b984-a37a89e6d5ae",
"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-03-28T12:38:02.8636083+00:00"
},
"modified_dateutc": "2025-03-28T12:38:02.8636083+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6c74805c-6df4-49b9-b458-e59b9f51c5ae",
"date_reported_by_company": "2025-03-28T12:38:02.8636083+00:00",
"id2": 36,
"company_id": "a792718c-27a2-4f4f-90fb-3cbcf47205a2",
"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": "edecc246-0ef7-4275-b867-46c4ae41eef2",
"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-03-28T12:38:02.8636083+00:00"
},
"work_instruction_details_id": "15761664-e3b5-4210-9623-cb98f03ca678",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "048e2a3b-500f-41cc-aa17-7742449304f6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d1cbe2cc-b85f-443f-becc-16336f12192e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-03-28T12:38:02.8636083+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": "e04fc48c-6655-451b-940e-a8157efb7e28",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-03-28T12:38:02.8636083+00:00"
}