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": "317189eb-b37b-4abc-97eb-5bf25e8c0e7c",
"jobs_id": "a228f7ec-991b-4b45-926d-2cc429b39a63",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cd68ea7a-e756-48d8-8f98-44a9ed634131",
"_parent_id": "50912530-a09d-4ff2-9166-b7ac77b7e31b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2e64402c-6156-441b-85c4-980c746b9710",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cd378086-8623-4bef-bf11-ebadf96ea80b",
"_parent_id": "84ae90fe-afd7-4af0-b254-ac1d05d97a83",
"root_parent_id": "745913a4-3cd2-4950-a11e-3134220549af",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a43576b4-d907-430b-b0e0-9b5b0144d5c5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "456bcc9f-5d83-4a1c-a0d2-a90a6d76645d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2179a6ab-3700-43db-ae6c-f643d2a6b9d3",
"_parent_code": "sample string 6",
"sales_organization_id": "b0b18ef2-0f14-482f-b324-dc95e8844274",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4da8800e-aa35-493a-a2c6-076246fdba41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1057a44d-4858-4150-8e23-1d34217e7e35",
"db_currency_id": "3273b5fc-2a6c-4b74-922e-29883e26cd41",
"db_language_id": "bb63a5b2-9961-4951-aa7c-d55c1a21504e",
"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-02-05T07:01:22.8773427+00:00"
},
"modified_dateutc": "2025-02-05T07:01:22.8773427+00:00"
},
"equipment_model_id": "4472402f-5924-4cdb-ae1a-5bb79de6923a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0da06614-d5c0-44a0-a45f-bd5b473ab2d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8c86cada-a310-4913-b516-cb46c314d58d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "91c622ee-92f4-4e01-9310-aab889dcddca",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2a6a2409-da0d-4b01-a66e-44164b653131",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4da8800e-aa35-493a-a2c6-076246fdba41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1057a44d-4858-4150-8e23-1d34217e7e35",
"db_currency_id": "3273b5fc-2a6c-4b74-922e-29883e26cd41",
"db_language_id": "bb63a5b2-9961-4951-aa7c-d55c1a21504e",
"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-02-05T07:01:22.8773427+00:00"
},
"modified_dateutc": "2025-02-05T07:01:22.8773427+00:00"
},
"equipment_family_id": "a4680eef-c327-41f9-aeaf-ee6d0c7e7a2c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "456bcc9f-5d83-4a1c-a0d2-a90a6d76645d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2179a6ab-3700-43db-ae6c-f643d2a6b9d3",
"_parent_code": "sample string 6",
"sales_organization_id": "b0b18ef2-0f14-482f-b324-dc95e8844274",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4da8800e-aa35-493a-a2c6-076246fdba41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1057a44d-4858-4150-8e23-1d34217e7e35",
"db_currency_id": "3273b5fc-2a6c-4b74-922e-29883e26cd41",
"db_language_id": "bb63a5b2-9961-4951-aa7c-d55c1a21504e",
"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-02-05T07:01:22.8773427+00:00"
},
"modified_dateutc": "2025-02-05T07:01:22.8773427+00:00"
},
"date_in_production_since": "2025-02-05T07:01:22.8773427+00:00",
"date_out_of_production_since": "2025-02-05T07:01:22.8773427+00:00",
"date_end_support": "2025-02-05T07:01:22.8773427+00:00",
"sales_organization_id": "4231d3d4-6e5c-44d9-9805-043475c5928e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4da8800e-aa35-493a-a2c6-076246fdba41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1057a44d-4858-4150-8e23-1d34217e7e35",
"db_currency_id": "3273b5fc-2a6c-4b74-922e-29883e26cd41",
"db_language_id": "bb63a5b2-9961-4951-aa7c-d55c1a21504e",
"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-02-05T07:01:22.8773427+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-02-05T07:01:22.8773427+00:00"
},
"project_status_id": "8c28b193-476e-413a-9f22-6edf9bd5e882",
"project_status_code": "sample string 10",
"project_status": {
"id": "1c77aedf-3826-4629-b521-f92fdb08ee08",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "25ea4285-8bc1-4d65-a711-5c9b16f8715b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4da8800e-aa35-493a-a2c6-076246fdba41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1057a44d-4858-4150-8e23-1d34217e7e35",
"db_currency_id": "3273b5fc-2a6c-4b74-922e-29883e26cd41",
"db_language_id": "bb63a5b2-9961-4951-aa7c-d55c1a21504e",
"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-02-05T07:01:22.8773427+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-02-05T07:01:22.8773427+00:00"
},
"company_id": "2ff5714a-f899-469c-b221-1598403adaf0",
"company_code": "sample string 12",
"db_address_id": "7df4ea08-0afe-4e25-a8e5-d8b6a8117c7e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9c5f7ba2-902e-48b2-be08-a66c535e90db",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "56a2ee05-47b9-473d-8d47-ca97dd5af0b9",
"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-02-05T07:01:22.8773427+00:00",
"date_create": "2025-02-05T07:01:22.8773427+00:00",
"date_update": "2025-02-05T07:01:22.8773427+00:00",
"updated_by_user_id": "ddee3818-1638-4329-bfd8-6ee161020f0b",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-02-05T07:01:22.8773427+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-02-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-02-05T07:01:22.8773427+00:00",
"date_last_job": "2025-02-05T07:01:22.8773427+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-02-05T07:01:22.8773427+00:00",
"modified_dateutc": "2025-02-05T07:01:22.8773427+00:00",
"is_mobile_installation": true
},
"job_type_id": "0fa25201-e414-4393-acad-e1ec7c354055",
"job_type_code": "sample string 7",
"job_type": {
"id": "d4e30707-2639-474c-adca-662f71e5c45b",
"name": "sample string 2",
"sales_organization_id": "5c2914d4-a853-4bf7-b5a4-746a186caa64",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-02-05T07:01:22.8773427+00:00",
"code": "sample string 7"
},
"job_priority_id": "1b62b70c-fb9b-4e27-8735-751f13b6c22e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fec78eef-2f1b-45a6-8d90-ae3f2bb0e3a6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "40ed009e-318b-4660-9275-84b220dc6fec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4da8800e-aa35-493a-a2c6-076246fdba41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1057a44d-4858-4150-8e23-1d34217e7e35",
"db_currency_id": "3273b5fc-2a6c-4b74-922e-29883e26cd41",
"db_language_id": "bb63a5b2-9961-4951-aa7c-d55c1a21504e",
"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-02-05T07:01:22.8773427+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-02-05T07:01:22.8773427+00:00"
},
"job_status_id": "986e4e52-de6c-4992-83b9-e296dfd3d476",
"job_status_code": "sample string 11",
"db_address_id": "b647f31b-213b-4afc-86b9-3aeb10ace5e6",
"contact_id": "ad361b49-872e-42e0-98f9-20135c7e01c6",
"requested_by_company_id": "364d81e7-52d7-4c6a-81ee-f98c04edb0c5",
"requested_by_contact_id": "6ab8cad9-0216-4312-8894-5159d541477e",
"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-02-05T07:01:22.8773427+00:00",
"due_date": "2025-02-05T07:01:22.8773427+00:00",
"date_create": "2025-02-05T07:01:22.8773427+00:00",
"date_update": "2025-02-05T07:01:22.8773427+00:00",
"date_closed": "2025-02-05T07:01:22.8773427+00:00",
"suggested_user_id": "ccac9901-5a29-46c7-ac1b-e28e3e97e6bc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b100e73b-55be-403d-b482-85ea6d5bd468",
"db_language_id": "45374d5e-eb13-4477-b669-ec233968a4f1",
"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-02-05T07:01:22.8773427+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f0d0dfbc-e695-4a9a-affe-885a523dbfb9",
"sales_organization": {
"id": "4da8800e-aa35-493a-a2c6-076246fdba41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1057a44d-4858-4150-8e23-1d34217e7e35",
"db_currency_id": "3273b5fc-2a6c-4b74-922e-29883e26cd41",
"db_language_id": "bb63a5b2-9961-4951-aa7c-d55c1a21504e",
"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-02-05T07:01:22.8773427+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "db84cccb-b0f1-408a-8c7f-f06f3792dbd3",
"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": "8216642d-daa7-41bb-97ac-3d3b0bf44655",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-02-05T07:01:22.8773427+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "132fc61c-311e-4e79-a8f1-76d182753cff"
},
"suggested_date_start": "2025-02-05T07:01:22.8773427+00:00",
"skill_id": "bedfe3dc-8eff-4391-abd9-db51854299c5",
"skill_code": "sample string 32",
"skill": {
"id": "d0f4df38-72d8-42f4-b2a3-071a4a07aeda",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d3994a1d-e29e-41e9-be9b-cee36cfa8b2b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4da8800e-aa35-493a-a2c6-076246fdba41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1057a44d-4858-4150-8e23-1d34217e7e35",
"db_currency_id": "3273b5fc-2a6c-4b74-922e-29883e26cd41",
"db_language_id": "bb63a5b2-9961-4951-aa7c-d55c1a21504e",
"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-02-05T07:01:22.8773427+00:00"
},
"modified_dateutc": "2025-02-05T07:01:22.8773427+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c5b3a9af-3dcf-494b-b361-ef2d5bd91686",
"date_reported_by_company": "2025-02-05T07:01:22.8773427+00:00",
"id2": 36,
"company_id": "867161a5-0a6c-4d81-a0a2-e49a8aac5151",
"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": "c99a58fc-765d-45bf-8159-6b3d51f9d027",
"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-02-05T07:01:22.8773427+00:00"
},
"work_instruction_details_id": "4a40ffdb-af2c-4c6f-ac20-d7ee9f5e919f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "539f5c65-1b5b-4d16-a7ec-22e01ec2d169",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d2f5ea85-2eca-47d3-b638-21e63fdba8d0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-02-05T07:01:22.8773427+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": "b0689c78-b3a7-4f51-afd0-73bae3f6c931",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-02-05T07:01:22.8773427+00:00"
}