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": "43d269d2-8a21-4623-8614-6dceedeb18a0",
"jobs_id": "529c76d3-486a-4b22-9ec6-0c439e083b2d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "49a9a9df-ba8b-4eb2-a8f1-7acb38943dbf",
"_parent_id": "523f1391-94b7-413d-9ad8-e47415e02776",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "68dd180a-ca94-4c75-978f-f9f549e5fb1d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f2805d76-288b-4c8f-b825-5d81ca7c6e15",
"_parent_id": "168b3ce1-b5da-4081-a7ad-34c0ad12967c",
"root_parent_id": "37b1e102-8b7c-48b0-87d3-9a38872a9c6e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bc30ca23-f4d1-4040-8750-4f6160c5dd1e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ad824a42-7ebf-45c1-a261-f601d84e934e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2b2cfa66-75b4-4730-a236-109fba68ba62",
"_parent_code": "sample string 6",
"sales_organization_id": "127bf4a3-c447-469d-9b4e-69f4e62a99a5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "058783b2-8824-4cf9-bccc-4da6dca85ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa086f1-f90b-43ef-a258-05867270f66d",
"db_currency_id": "e41bd914-f444-4e7a-a04a-a5b284b70f2b",
"db_language_id": "ae4c530d-a619-4d02-9c5a-adbdc3612619",
"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": "2024-12-21T17:24:36.1720918+00:00"
},
"modified_dateutc": "2024-12-21T17:24:36.1720918+00:00"
},
"equipment_model_id": "7e398eb6-b5d1-49d7-939b-d07916fe6c50",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "00f11b53-3060-40f7-bc71-6601d449ef06",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "caafd960-3706-42e4-8deb-41df799b7c03",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "12c4149c-38d5-430e-b01d-38ca2e1f4ff6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "db3ea1b9-1afe-4381-b18c-29228747bfc3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "058783b2-8824-4cf9-bccc-4da6dca85ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa086f1-f90b-43ef-a258-05867270f66d",
"db_currency_id": "e41bd914-f444-4e7a-a04a-a5b284b70f2b",
"db_language_id": "ae4c530d-a619-4d02-9c5a-adbdc3612619",
"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": "2024-12-21T17:24:36.1720918+00:00"
},
"modified_dateutc": "2024-12-21T17:24:36.1720918+00:00"
},
"equipment_family_id": "8fca09ea-1429-41ac-944a-8eacf227b4ba",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ad824a42-7ebf-45c1-a261-f601d84e934e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2b2cfa66-75b4-4730-a236-109fba68ba62",
"_parent_code": "sample string 6",
"sales_organization_id": "127bf4a3-c447-469d-9b4e-69f4e62a99a5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "058783b2-8824-4cf9-bccc-4da6dca85ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa086f1-f90b-43ef-a258-05867270f66d",
"db_currency_id": "e41bd914-f444-4e7a-a04a-a5b284b70f2b",
"db_language_id": "ae4c530d-a619-4d02-9c5a-adbdc3612619",
"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": "2024-12-21T17:24:36.1720918+00:00"
},
"modified_dateutc": "2024-12-21T17:24:36.1720918+00:00"
},
"date_in_production_since": "2024-12-21T17:24:36.1720918+00:00",
"date_out_of_production_since": "2024-12-21T17:24:36.1720918+00:00",
"date_end_support": "2024-12-21T17:24:36.1720918+00:00",
"sales_organization_id": "186a320c-25bb-456e-b947-3b4e07f64e81",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "058783b2-8824-4cf9-bccc-4da6dca85ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa086f1-f90b-43ef-a258-05867270f66d",
"db_currency_id": "e41bd914-f444-4e7a-a04a-a5b284b70f2b",
"db_language_id": "ae4c530d-a619-4d02-9c5a-adbdc3612619",
"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": "2024-12-21T17:24:36.1720918+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": "2024-12-21T17:24:36.1720918+00:00"
},
"project_status_id": "08af3935-b3d4-45db-9562-6ee170333391",
"project_status_code": "sample string 10",
"project_status": {
"id": "dcdfc4a8-b930-419d-be6a-1eaceb77fd03",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d3f51f14-44f4-4792-81f5-5c80c6b7f724",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "058783b2-8824-4cf9-bccc-4da6dca85ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa086f1-f90b-43ef-a258-05867270f66d",
"db_currency_id": "e41bd914-f444-4e7a-a04a-a5b284b70f2b",
"db_language_id": "ae4c530d-a619-4d02-9c5a-adbdc3612619",
"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": "2024-12-21T17:24:36.1720918+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-12-21T17:24:36.1720918+00:00"
},
"company_id": "17c5f679-ffaf-4925-9421-9c046987b271",
"company_code": "sample string 12",
"db_address_id": "54fe4887-bfd1-4d83-aa5a-a49b97ed9bf0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "bd440d68-63bb-4659-84d9-1fb9573c7821",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c0e53c79-371e-4d1e-bbf4-b3cd1a30a583",
"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": "2024-12-21T17:24:36.1720918+00:00",
"date_create": "2024-12-21T17:24:36.1720918+00:00",
"date_update": "2024-12-21T17:24:36.1720918+00:00",
"updated_by_user_id": "67614f1d-aae4-493c-b972-5620f609131b",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-12-21T17:24:36.1720918+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": "2024-12-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-12-21T17:24:36.1720918+00:00",
"date_last_job": "2024-12-21T17:24:36.1720918+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-12-21T17:24:36.1720918+00:00",
"modified_dateutc": "2024-12-21T17:24:36.1720918+00:00",
"is_mobile_installation": true
},
"job_type_id": "7dd1973e-e5b8-4d6c-b12c-1eb09e1536be",
"job_type_code": "sample string 7",
"job_type": {
"id": "082565fd-ae47-4c00-a4fa-3472d9c067f1",
"name": "sample string 2",
"sales_organization_id": "beb74c54-9e67-4105-872a-ca1fbe698855",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-12-21T17:24:36.1720918+00:00",
"code": "sample string 7"
},
"job_priority_id": "d6611943-245d-4db9-9af6-4d86c810eeab",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8b7a7ef5-7df3-4a7d-8226-e529f73d4a8f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d1cf7c1d-0db7-4f04-b7af-750dd0d3ca27",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "058783b2-8824-4cf9-bccc-4da6dca85ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa086f1-f90b-43ef-a258-05867270f66d",
"db_currency_id": "e41bd914-f444-4e7a-a04a-a5b284b70f2b",
"db_language_id": "ae4c530d-a619-4d02-9c5a-adbdc3612619",
"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": "2024-12-21T17:24:36.1720918+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-12-21T17:24:36.1720918+00:00"
},
"job_status_id": "4bb30926-d13b-480e-82ad-d1b63b556232",
"job_status_code": "sample string 11",
"db_address_id": "7e9c9251-896c-446f-ab24-4f26bec316b4",
"contact_id": "5b47087e-cd35-4d1b-920a-d4c48609030f",
"requested_by_company_id": "00adf2d3-5239-4a9b-9bf1-abeb8b521565",
"requested_by_contact_id": "42d6318a-0ad3-4f02-b131-c7fcd71f7ff9",
"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": "2024-12-21T17:24:36.1720918+00:00",
"due_date": "2024-12-21T17:24:36.1720918+00:00",
"date_create": "2024-12-21T17:24:36.1720918+00:00",
"date_update": "2024-12-21T17:24:36.1720918+00:00",
"date_closed": "2024-12-21T17:24:36.1720918+00:00",
"suggested_user_id": "dd416967-994c-48fb-adca-2b8a416ff617",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "97ef464b-66ca-4a56-9413-a49bb0e7a85e",
"db_language_id": "76bc2adf-def0-4001-a4e5-1dbbead00365",
"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": "2024-12-21T17:24:36.1720918+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fe9d3ad4-25dd-49bf-a822-7af6d1522919",
"sales_organization": {
"id": "058783b2-8824-4cf9-bccc-4da6dca85ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa086f1-f90b-43ef-a258-05867270f66d",
"db_currency_id": "e41bd914-f444-4e7a-a04a-a5b284b70f2b",
"db_language_id": "ae4c530d-a619-4d02-9c5a-adbdc3612619",
"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": "2024-12-21T17:24:36.1720918+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fb0e4d2d-4594-49df-a6b9-7bff91ea157c",
"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": "f8de8142-a0ff-4c56-9b73-92f9fc562ca2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-12-21T17:24:36.1720918+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "56b9a83e-d235-4d3d-b67d-968ac83e6c47"
},
"suggested_date_start": "2024-12-21T17:24:36.1720918+00:00",
"skill_id": "778a1178-c9ad-4639-b21a-ab9c92cbeb44",
"skill_code": "sample string 32",
"skill": {
"id": "b3276b55-6ff5-45d0-82df-73b5d1bddba8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2f3b455c-766e-49d7-8d61-e664009b671c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "058783b2-8824-4cf9-bccc-4da6dca85ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa086f1-f90b-43ef-a258-05867270f66d",
"db_currency_id": "e41bd914-f444-4e7a-a04a-a5b284b70f2b",
"db_language_id": "ae4c530d-a619-4d02-9c5a-adbdc3612619",
"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": "2024-12-21T17:24:36.1720918+00:00"
},
"modified_dateutc": "2024-12-21T17:24:36.1720918+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "762bf704-a06e-4b53-951c-3bb6f1d75db2",
"date_reported_by_company": "2024-12-21T17:24:36.1720918+00:00",
"id2": 36,
"company_id": "efd5da79-c769-4077-8b87-544151325a2f",
"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": "9bb1194e-d32f-46f6-a0e3-1512bf5b4f4d",
"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": "2024-12-21T17:24:36.1720918+00:00"
},
"work_instruction_details_id": "ace2ba00-c832-4e32-9c82-2adf9a1ad5b4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f1c740a7-fff7-40fa-a996-dffa55c0390a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "096550d5-638b-4ef2-bd5b-3379396d2e0f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-12-21T17:24:36.1720918+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": "71d056ae-4501-491a-97c6-492ddec64798",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-12-21T17:24:36.1720918+00:00"
}