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": "010c78a0-bf7a-49c9-a86d-eebf82c29f0b",
"jobs_id": "6441f2c4-b5da-471f-8e17-835f3d3ae147",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "32969b09-d34e-4b99-83dd-a7ee901f3634",
"_parent_id": "b534099e-8ba6-4c05-9758-46b6959a500e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dcd894a8-eee7-47a0-8fda-161e8a1ab3ce",
"project_reference_back_office": "sample string 5",
"project": {
"id": "85e269be-f6fe-4454-b384-3b66812163a0",
"_parent_id": "c19191a0-51f5-405e-a8ec-78f205350302",
"root_parent_id": "5ccc3cb6-ecf2-40b9-85de-64b867365b47",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "555e0786-0f16-454c-b4ef-f825b203d94e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "090cf8b5-dc7e-419b-af45-cc1aa0229f75",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1669b799-b8b5-4367-be22-2f3615c48860",
"_parent_code": "sample string 6",
"sales_organization_id": "ff93c2e6-aeb9-4a2e-a264-dd18551879cd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6ee23836-ce62-403b-bc38-b7cef0b34fae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a5fd323-4ea5-488e-8115-6739a6cb33c3",
"db_currency_id": "62ec7ad8-de20-4bc8-8448-d8c03741dbde",
"db_language_id": "0776b677-9af1-41d5-a6f4-ac2ae9b0a4df",
"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-19T10:14:48.1993945+00:00"
},
"modified_dateutc": "2025-02-19T10:14:48.1993945+00:00"
},
"equipment_model_id": "b668dd24-daf2-40db-85b4-de9260ab09dd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bf621e57-26dd-4c1a-9bef-74f1cd829fe4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6a1881c3-76fa-4142-b0a0-8afc44ac5ce1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "37b25aa2-bc1b-4d7a-8d77-9a78e34e204e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ad61a3e5-17ea-4486-8ef8-69c873e784e7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6ee23836-ce62-403b-bc38-b7cef0b34fae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a5fd323-4ea5-488e-8115-6739a6cb33c3",
"db_currency_id": "62ec7ad8-de20-4bc8-8448-d8c03741dbde",
"db_language_id": "0776b677-9af1-41d5-a6f4-ac2ae9b0a4df",
"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-19T10:14:48.1993945+00:00"
},
"modified_dateutc": "2025-02-19T10:14:48.1993945+00:00"
},
"equipment_family_id": "c49cfb27-f0bb-4c7e-8846-02e90d3ad1b7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "090cf8b5-dc7e-419b-af45-cc1aa0229f75",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1669b799-b8b5-4367-be22-2f3615c48860",
"_parent_code": "sample string 6",
"sales_organization_id": "ff93c2e6-aeb9-4a2e-a264-dd18551879cd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6ee23836-ce62-403b-bc38-b7cef0b34fae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a5fd323-4ea5-488e-8115-6739a6cb33c3",
"db_currency_id": "62ec7ad8-de20-4bc8-8448-d8c03741dbde",
"db_language_id": "0776b677-9af1-41d5-a6f4-ac2ae9b0a4df",
"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-19T10:14:48.1993945+00:00"
},
"modified_dateutc": "2025-02-19T10:14:48.1993945+00:00"
},
"date_in_production_since": "2025-02-19T10:14:48.1993945+00:00",
"date_out_of_production_since": "2025-02-19T10:14:48.1993945+00:00",
"date_end_support": "2025-02-19T10:14:48.1993945+00:00",
"sales_organization_id": "adbc1c13-4651-4bda-8322-7a8743d6e827",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6ee23836-ce62-403b-bc38-b7cef0b34fae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a5fd323-4ea5-488e-8115-6739a6cb33c3",
"db_currency_id": "62ec7ad8-de20-4bc8-8448-d8c03741dbde",
"db_language_id": "0776b677-9af1-41d5-a6f4-ac2ae9b0a4df",
"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-19T10:14:48.1993945+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-19T10:14:48.1993945+00:00"
},
"project_status_id": "d0822835-dda7-4d77-be79-85e911934f7d",
"project_status_code": "sample string 10",
"project_status": {
"id": "a5889149-43f3-4c2e-8842-8dcdb7442360",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "70a0e7bc-f334-4c40-b78d-897019737dbf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6ee23836-ce62-403b-bc38-b7cef0b34fae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a5fd323-4ea5-488e-8115-6739a6cb33c3",
"db_currency_id": "62ec7ad8-de20-4bc8-8448-d8c03741dbde",
"db_language_id": "0776b677-9af1-41d5-a6f4-ac2ae9b0a4df",
"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-19T10:14:48.1993945+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-02-19T10:14:48.1993945+00:00"
},
"company_id": "759c7652-4f58-43a1-a29c-58fa9be50744",
"company_code": "sample string 12",
"db_address_id": "d2c662d2-c07f-4b9e-a225-d570a7685589",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "bf284f7a-355f-41cd-b3dd-bd2e8a22b531",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1ea399db-9c98-49b3-8a3d-c82d59d04112",
"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-19T10:14:48.1993945+00:00",
"date_create": "2025-02-19T10:14:48.1993945+00:00",
"date_update": "2025-02-19T10:14:48.1993945+00:00",
"updated_by_user_id": "edfdca33-0baa-4c49-ab28-83e8402ec155",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-02-19T10:14:48.1993945+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-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-02-19T10:14:48.1993945+00:00",
"date_last_job": "2025-02-19T10:14:48.1993945+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-02-19T10:14:48.1993945+00:00",
"modified_dateutc": "2025-02-19T10:14:48.1993945+00:00",
"is_mobile_installation": true
},
"job_type_id": "744ffd45-34a7-471c-ba2d-c9e5ac9c4110",
"job_type_code": "sample string 7",
"job_type": {
"id": "f20ae9ae-453c-426d-826d-0118219766f0",
"name": "sample string 2",
"sales_organization_id": "c4b0c343-874e-42bc-9d93-b9118bb4e1ec",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-02-19T10:14:48.1993945+00:00",
"code": "sample string 7"
},
"job_priority_id": "25e3ae58-be02-4b7d-9804-7b2d20245d38",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "97ba5ead-07f0-452d-9d2c-48716f69fe73",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7ee4a7c3-ed73-4be4-b573-4e0027965806",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6ee23836-ce62-403b-bc38-b7cef0b34fae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a5fd323-4ea5-488e-8115-6739a6cb33c3",
"db_currency_id": "62ec7ad8-de20-4bc8-8448-d8c03741dbde",
"db_language_id": "0776b677-9af1-41d5-a6f4-ac2ae9b0a4df",
"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-19T10:14:48.1993945+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-02-19T10:14:48.1993945+00:00"
},
"job_status_id": "bc8e529d-32be-46af-8ad3-adce51deef04",
"job_status_code": "sample string 11",
"db_address_id": "17ae2e62-3ead-478d-878d-7ca853ce2d55",
"contact_id": "dc49536e-c2d9-4681-b5d9-cb744b06fa13",
"requested_by_company_id": "aa751f23-4057-4a10-b952-3b33bd6d1333",
"requested_by_contact_id": "62784207-3edf-4a54-ab68-808047b32d78",
"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-19T10:14:48.1993945+00:00",
"due_date": "2025-02-19T10:14:48.1993945+00:00",
"date_create": "2025-02-19T10:14:48.1993945+00:00",
"date_update": "2025-02-19T10:14:48.1993945+00:00",
"date_closed": "2025-02-19T10:14:48.1993945+00:00",
"suggested_user_id": "5135ea14-6cdf-40e8-9e45-8fc0365f845a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "622a972f-4a58-47f8-b7e9-1d570c49ac11",
"db_language_id": "516457a4-c1c4-452f-836d-511d4ab462f5",
"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-19T10:14:48.1993945+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "59d62561-5fc2-4450-8791-fd2dc67f2ba0",
"sales_organization": {
"id": "6ee23836-ce62-403b-bc38-b7cef0b34fae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a5fd323-4ea5-488e-8115-6739a6cb33c3",
"db_currency_id": "62ec7ad8-de20-4bc8-8448-d8c03741dbde",
"db_language_id": "0776b677-9af1-41d5-a6f4-ac2ae9b0a4df",
"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-19T10:14:48.1993945+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d9310d8c-8edd-4008-899b-250dba328f44",
"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": "f1bdfad9-0997-47ca-806f-c4fd92c35b1d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-02-19T10:14:48.1993945+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9d4f68ac-5447-4fb5-b6fc-6a9fba5d63a1"
},
"suggested_date_start": "2025-02-19T10:14:48.1993945+00:00",
"skill_id": "4a0be1b3-63b5-4c26-abf6-5210b8dff9d7",
"skill_code": "sample string 32",
"skill": {
"id": "6d21f8ce-6fa6-4daf-bec6-cda62f29017f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4779cc11-fb52-4872-bace-cefe926bdff9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6ee23836-ce62-403b-bc38-b7cef0b34fae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a5fd323-4ea5-488e-8115-6739a6cb33c3",
"db_currency_id": "62ec7ad8-de20-4bc8-8448-d8c03741dbde",
"db_language_id": "0776b677-9af1-41d5-a6f4-ac2ae9b0a4df",
"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-19T10:14:48.1993945+00:00"
},
"modified_dateutc": "2025-02-19T10:14:48.1993945+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "751f5ba9-ac5f-49df-ad32-f428e7c34c83",
"date_reported_by_company": "2025-02-19T10:14:48.1993945+00:00",
"id2": 36,
"company_id": "e042583c-ee19-426d-8f05-1bdfe048b041",
"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": "7749ca16-8418-4cec-81c4-9d04851155e9",
"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-19T10:14:48.1993945+00:00"
},
"work_instruction_details_id": "7a4b9526-9143-403c-b54b-320dc3a9853c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "08433ddb-3dcf-441a-b991-4770949569f4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5977adf8-fcc3-40be-81bd-fe16e28ec008",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-02-19T10:14:48.1993945+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": "e3b33802-b311-4746-8ab5-08709a4e32ad",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-02-19T10:14:48.1993945+00:00"
}