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": "2a01199e-be8b-45ea-8b0c-eb8b0b9ac1ca",
"jobs_id": "7930760e-f9d2-473b-9521-30b834fe6fa6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7f9bc418-02eb-4cb1-bdea-2962b1f0b185",
"_parent_id": "1fdb6a81-9d7f-4766-ad01-42931d38cfb9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "05eaec59-18ad-4b31-b7c2-7e5ebaea4065",
"project_reference_back_office": "sample string 5",
"project": {
"id": "88178755-09d7-4650-a36b-71c91a324545",
"_parent_id": "0d7b65f0-f2ff-4a1e-9b68-2a6f34e550dc",
"root_parent_id": "2119f400-5af0-4bb3-bcb4-4790f22d062f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "356fdbf7-9ea6-47ae-9913-2e3a88a64ae3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "51d34902-e668-4c71-a580-3fa49ec69daf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e87a7227-a4ac-4267-ab96-ea592630a8e6",
"_parent_code": "sample string 6",
"sales_organization_id": "cff1d9a7-1899-4f4c-9785-e041ba5bd915",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7a41ebe-8a38-44a8-bc8d-05494ae6f3c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e0b13a8-8697-47b9-9f73-7f748b46cc47",
"db_currency_id": "03e2ba8c-dcca-472a-a130-efedbc26b26b",
"db_language_id": "57e0ba08-1b4c-4056-ab6f-741722b15587",
"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": "2023-03-20T13:55:10.6421487+00:00"
},
"modified_dateutc": "2023-03-20T13:55:10.6421487+00:00"
},
"equipment_model_id": "0f7b28e7-5a80-45b6-b001-88621ef63bca",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "36d31261-3ef7-4cb7-9f63-f114fc934691",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ebd32755-4b68-4556-81de-4af8ad81e37d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ff6a2a50-12da-4880-ab23-35086b757b01",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b42fe408-e866-42da-897d-c4bb12601713",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d7a41ebe-8a38-44a8-bc8d-05494ae6f3c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e0b13a8-8697-47b9-9f73-7f748b46cc47",
"db_currency_id": "03e2ba8c-dcca-472a-a130-efedbc26b26b",
"db_language_id": "57e0ba08-1b4c-4056-ab6f-741722b15587",
"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": "2023-03-20T13:55:10.6421487+00:00"
},
"modified_dateutc": "2023-03-20T13:55:10.6421487+00:00"
},
"equipment_family_id": "e71d8c82-3c09-4d98-9aba-ae41b116274f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "51d34902-e668-4c71-a580-3fa49ec69daf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e87a7227-a4ac-4267-ab96-ea592630a8e6",
"_parent_code": "sample string 6",
"sales_organization_id": "cff1d9a7-1899-4f4c-9785-e041ba5bd915",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7a41ebe-8a38-44a8-bc8d-05494ae6f3c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e0b13a8-8697-47b9-9f73-7f748b46cc47",
"db_currency_id": "03e2ba8c-dcca-472a-a130-efedbc26b26b",
"db_language_id": "57e0ba08-1b4c-4056-ab6f-741722b15587",
"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": "2023-03-20T13:55:10.6421487+00:00"
},
"modified_dateutc": "2023-03-20T13:55:10.6421487+00:00"
},
"date_in_production_since": "2023-03-20T13:55:10.6421487+00:00",
"date_out_of_production_since": "2023-03-20T13:55:10.6421487+00:00",
"date_end_support": "2023-03-20T13:55:10.6421487+00:00",
"sales_organization_id": "e58010d6-c9ef-48c5-a397-e4ad6f67bf67",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d7a41ebe-8a38-44a8-bc8d-05494ae6f3c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e0b13a8-8697-47b9-9f73-7f748b46cc47",
"db_currency_id": "03e2ba8c-dcca-472a-a130-efedbc26b26b",
"db_language_id": "57e0ba08-1b4c-4056-ab6f-741722b15587",
"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": "2023-03-20T13:55:10.6421487+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": "2023-03-20T13:55:10.6421487+00:00"
},
"project_status_id": "b26ea8ea-7d58-4fa1-8ff6-935ee85db33c",
"project_status_code": "sample string 10",
"project_status": {
"id": "d9882947-308a-4a05-8832-f3d4b46477e0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e372cb4a-96c6-40ff-8558-606adca7ca00",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7a41ebe-8a38-44a8-bc8d-05494ae6f3c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e0b13a8-8697-47b9-9f73-7f748b46cc47",
"db_currency_id": "03e2ba8c-dcca-472a-a130-efedbc26b26b",
"db_language_id": "57e0ba08-1b4c-4056-ab6f-741722b15587",
"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": "2023-03-20T13:55:10.6421487+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-03-20T13:55:10.6421487+00:00"
},
"company_id": "00ec97af-d312-4ee9-8dfe-a09f5153b8b0",
"company_code": "sample string 12",
"db_address_id": "92d16898-b818-4bb9-a3ca-aa9e0aaa7374",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5d65ebba-10a4-4fb2-bab1-041c3c5b463f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "be96973d-9289-4eb1-b748-acf8fa38ec67",
"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": "2023-03-20T13:55:10.6421487+00:00",
"date_create": "2023-03-20T13:55:10.6421487+00:00",
"date_update": "2023-03-20T13:55:10.6421487+00:00",
"updated_by_user_id": "f1a01fe6-babc-4fab-a9d8-1c44bad60b51",
"customer_reference": "sample string 28",
"warranty_date_until": "2023-03-20T13:55:10.6421487+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": "2023-03-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2023-03-20T13:55:10.6421487+00:00",
"date_last_job": "2023-03-20T13:55:10.6421487+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2023-03-20T13:55:10.6421487+00:00",
"modified_dateutc": "2023-03-20T13:55:10.6421487+00:00",
"is_mobile_installation": true
},
"job_type_id": "b4c55497-8893-434c-86fd-4801e72c9bc9",
"job_type_code": "sample string 7",
"job_type": {
"id": "c35aa572-4d19-4f45-b5ed-22483d905c0b",
"name": "sample string 2",
"sales_organization_id": "9b891da4-466a-4a9b-aeda-2954f4bc1671",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2023-03-20T13:55:10.6421487+00:00",
"code": "sample string 7"
},
"job_priority_id": "87212d1e-618c-4017-994a-124b7da9e4cd",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "11fd06d0-740c-4021-913f-b2c243f8b9ce",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c4584944-b5f9-4d39-95c5-cb6175c4ec84",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7a41ebe-8a38-44a8-bc8d-05494ae6f3c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e0b13a8-8697-47b9-9f73-7f748b46cc47",
"db_currency_id": "03e2ba8c-dcca-472a-a130-efedbc26b26b",
"db_language_id": "57e0ba08-1b4c-4056-ab6f-741722b15587",
"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": "2023-03-20T13:55:10.6421487+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-03-20T13:55:10.6421487+00:00"
},
"job_status_id": "9693e099-1135-4224-b2cf-91fea65b6306",
"job_status_code": "sample string 11",
"db_address_id": "27fd3cb9-ffb4-4a4e-b09d-71bdb5be08e1",
"contact_id": "52fef787-70a5-486b-85c3-9cce679c1222",
"requested_by_company_id": "bc07346e-7880-41d5-9221-a0d04bbf7212",
"requested_by_contact_id": "c2e043f2-af6d-42dc-bc3f-2aa0e21cfc30",
"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": "2023-03-20T13:55:10.6421487+00:00",
"due_date": "2023-03-20T13:55:10.6421487+00:00",
"date_create": "2023-03-20T13:55:10.6421487+00:00",
"date_update": "2023-03-20T13:55:10.6421487+00:00",
"date_closed": "2023-03-20T13:55:10.6421487+00:00",
"suggested_user_id": "8d22c759-ae68-47cb-8f90-3d71d9d2d1b7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7c3ee025-f9a7-4584-ad7b-e02836f4516f",
"db_language_id": "53eb13a1-ff7a-44ec-8f18-580b3c94533e",
"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": "2023-03-20T13:55:10.6421487+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c8c2a1b4-9cb3-4051-8ed1-20842199fa85",
"sales_organization": {
"id": "d7a41ebe-8a38-44a8-bc8d-05494ae6f3c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e0b13a8-8697-47b9-9f73-7f748b46cc47",
"db_currency_id": "03e2ba8c-dcca-472a-a130-efedbc26b26b",
"db_language_id": "57e0ba08-1b4c-4056-ab6f-741722b15587",
"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": "2023-03-20T13:55:10.6421487+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ea460dad-bd9a-4768-b0f1-a8c068d5be44",
"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": "8c1e1ff4-694b-43e2-9fb4-155c140481b7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2023-03-20T13:55:10.6421487+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "93c070c6-0b71-41b6-a438-b4259994d438"
},
"suggested_date_start": "2023-03-20T13:55:10.6421487+00:00",
"skill_id": "87216a69-bb16-402e-bc9f-bbf9afca92c6",
"skill_code": "sample string 32",
"skill": {
"id": "3f58f356-1c9a-456b-876a-29a659765ead",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1cc85004-b36a-4d5b-b2d5-3dab03f44d69",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7a41ebe-8a38-44a8-bc8d-05494ae6f3c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e0b13a8-8697-47b9-9f73-7f748b46cc47",
"db_currency_id": "03e2ba8c-dcca-472a-a130-efedbc26b26b",
"db_language_id": "57e0ba08-1b4c-4056-ab6f-741722b15587",
"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": "2023-03-20T13:55:10.6421487+00:00"
},
"modified_dateutc": "2023-03-20T13:55:10.6421487+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "42c9fcbc-a52e-4c61-b1d8-507e7cc2961b",
"date_reported_by_company": "2023-03-20T13:55:10.6421487+00:00",
"id2": 36,
"company_id": "c999a1fb-aa70-4699-bd7c-561172882892",
"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": "b6266666-72cf-40bc-ad8e-46b100e8b154",
"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": "2023-03-20T13:55:10.6421487+00:00"
},
"work_instruction_details_id": "433b4318-1aea-4468-b312-418fae57bed4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "93f27578-8522-449a-9fb9-53c4c9a4796c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "53877b05-758d-4c1d-931a-0b17fcd0d923",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2023-03-20T13:55:10.6421487+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": "e9cbb8a4-3e74-41b5-8d7c-cb219f281726",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2023-03-20T13:55:10.6421487+00:00"
}