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": "c13d4682-cb0a-4320-a26d-b0809f3fe7bb",
"jobs_id": "fa6b9020-92bd-482d-a2a7-81f262412b85",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "91d4c83b-2caf-49f4-9c3b-1c7d04ff1069",
"_parent_id": "1c7645ed-fde8-4e23-aa0b-7eb6c2c83432",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e09fa7fe-c674-4b97-944e-2df503f86acb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7e478b99-700a-47d6-b289-8754434c92a5",
"_parent_id": "64a7e4cb-1c7b-4a55-b2cb-b121bcc5f099",
"root_parent_id": "5ed8ddf0-17a1-4d67-81c9-993b96d35d5c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1259f8b2-51ef-46c4-a574-f45bc25452cc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "22654d80-6ed8-4206-8fd4-d81bc58734da",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "29bcfdf7-dfdb-4539-a879-2e6b73a6deee",
"_parent_code": "sample string 6",
"sales_organization_id": "9f11dc68-da1d-4a32-9533-c97d4f7ad220",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b7bc0e79-8750-4fdb-839f-2e780e539261",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c9b34ae-d202-433d-95e2-84dce0769a19",
"db_currency_id": "136d9c87-69b4-484b-ad34-ca7381c03829",
"db_language_id": "f41793b5-a408-4041-8456-001587b0cda0",
"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-11-21T09:50:04.4400942+00:00"
},
"modified_dateutc": "2024-11-21T09:50:04.4400942+00:00"
},
"equipment_model_id": "839898ce-fc30-42f8-943f-26b79f4d0021",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9ff60fcc-3863-48ff-bf61-5269b37f5de8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1e03a7e4-bc17-426a-8c60-b5fb1ef301a7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9a39bc9e-8bb8-4199-9996-4c1e743757dc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f08f77a8-08a1-4edf-9d09-80b55affe731",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b7bc0e79-8750-4fdb-839f-2e780e539261",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c9b34ae-d202-433d-95e2-84dce0769a19",
"db_currency_id": "136d9c87-69b4-484b-ad34-ca7381c03829",
"db_language_id": "f41793b5-a408-4041-8456-001587b0cda0",
"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-11-21T09:50:04.4400942+00:00"
},
"modified_dateutc": "2024-11-21T09:50:04.4400942+00:00"
},
"equipment_family_id": "6d66a95c-f595-4b92-9951-4a67b43c0caa",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "22654d80-6ed8-4206-8fd4-d81bc58734da",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "29bcfdf7-dfdb-4539-a879-2e6b73a6deee",
"_parent_code": "sample string 6",
"sales_organization_id": "9f11dc68-da1d-4a32-9533-c97d4f7ad220",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b7bc0e79-8750-4fdb-839f-2e780e539261",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c9b34ae-d202-433d-95e2-84dce0769a19",
"db_currency_id": "136d9c87-69b4-484b-ad34-ca7381c03829",
"db_language_id": "f41793b5-a408-4041-8456-001587b0cda0",
"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-11-21T09:50:04.4400942+00:00"
},
"modified_dateutc": "2024-11-21T09:50:04.4400942+00:00"
},
"date_in_production_since": "2024-11-21T09:50:04.4400942+00:00",
"date_out_of_production_since": "2024-11-21T09:50:04.4400942+00:00",
"date_end_support": "2024-11-21T09:50:04.4400942+00:00",
"sales_organization_id": "e289d8ee-8ad1-4d03-b71c-e7a3c8bbe023",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b7bc0e79-8750-4fdb-839f-2e780e539261",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c9b34ae-d202-433d-95e2-84dce0769a19",
"db_currency_id": "136d9c87-69b4-484b-ad34-ca7381c03829",
"db_language_id": "f41793b5-a408-4041-8456-001587b0cda0",
"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-11-21T09:50:04.4400942+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-11-21T09:50:04.4400942+00:00"
},
"project_status_id": "9d92dcd9-9997-4695-b939-d8e6c59f1ade",
"project_status_code": "sample string 10",
"project_status": {
"id": "24f2951b-dc0f-45ca-9e81-043513728156",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b7092cbd-534e-4373-bb0d-98cdb8ced4ae",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b7bc0e79-8750-4fdb-839f-2e780e539261",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c9b34ae-d202-433d-95e2-84dce0769a19",
"db_currency_id": "136d9c87-69b4-484b-ad34-ca7381c03829",
"db_language_id": "f41793b5-a408-4041-8456-001587b0cda0",
"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-11-21T09:50:04.4400942+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-11-21T09:50:04.4400942+00:00"
},
"company_id": "b8e78d7b-cbee-4b8f-9a5d-8409302b6cfc",
"company_code": "sample string 12",
"db_address_id": "b12cb15c-7444-4f8a-b8a3-6d00861431cd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "52a0523c-8aaa-46b5-9ff1-fd0726f854bf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7c54b0ec-e46f-47e2-a81e-3136a6de80cf",
"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-11-21T09:50:04.4400942+00:00",
"date_create": "2024-11-21T09:50:04.4400942+00:00",
"date_update": "2024-11-21T09:50:04.4400942+00:00",
"updated_by_user_id": "c5ffde1b-91ef-4905-bdc7-5f8015df1dc1",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-11-21T09:50:04.4400942+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-11-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-11-21T09:50:04.4400942+00:00",
"date_last_job": "2024-11-21T09:50:04.4400942+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-11-21T09:50:04.4400942+00:00",
"modified_dateutc": "2024-11-21T09:50:04.4400942+00:00",
"is_mobile_installation": true
},
"job_type_id": "38109d31-6448-4117-a961-f5133115008f",
"job_type_code": "sample string 7",
"job_type": {
"id": "bfeac5f2-7541-4771-8cce-0722fe1298f7",
"name": "sample string 2",
"sales_organization_id": "2d4e4e40-e0e5-40fb-8582-d2c3f79ac383",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-11-21T09:50:04.4400942+00:00",
"code": "sample string 7"
},
"job_priority_id": "26463105-cad5-4bbd-b506-431a03499131",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fb05a95c-733e-454a-9b73-9b5add179e26",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3a3a9e56-dddb-4d98-a433-3ee636abb8fb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b7bc0e79-8750-4fdb-839f-2e780e539261",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c9b34ae-d202-433d-95e2-84dce0769a19",
"db_currency_id": "136d9c87-69b4-484b-ad34-ca7381c03829",
"db_language_id": "f41793b5-a408-4041-8456-001587b0cda0",
"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-11-21T09:50:04.4400942+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-11-21T09:50:04.4400942+00:00"
},
"job_status_id": "88be6dc5-709a-4043-8b1f-301c2ec3b874",
"job_status_code": "sample string 11",
"db_address_id": "4d1260e4-97d8-468f-acd6-54740ea90f21",
"contact_id": "efa31fd4-7f0e-49b1-9063-c2a208462fa5",
"requested_by_company_id": "922d3304-b929-45b6-8211-c2add45d4f47",
"requested_by_contact_id": "cd4acebc-27ff-4a74-8e2a-da5d9f3646a0",
"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-11-21T09:50:04.4400942+00:00",
"due_date": "2024-11-21T09:50:04.4400942+00:00",
"date_create": "2024-11-21T09:50:04.4400942+00:00",
"date_update": "2024-11-21T09:50:04.4400942+00:00",
"date_closed": "2024-11-21T09:50:04.4400942+00:00",
"suggested_user_id": "b093909e-0fd5-4d97-87e7-e782b0ab6a5e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1daa3ae3-d915-4c85-95e8-60c442a24970",
"db_language_id": "bc99ef4a-7ae1-4702-a3f2-89c78fd23563",
"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-11-21T09:50:04.4400942+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1595283d-4e20-4f5a-b706-505659b9a255",
"sales_organization": {
"id": "b7bc0e79-8750-4fdb-839f-2e780e539261",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c9b34ae-d202-433d-95e2-84dce0769a19",
"db_currency_id": "136d9c87-69b4-484b-ad34-ca7381c03829",
"db_language_id": "f41793b5-a408-4041-8456-001587b0cda0",
"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-11-21T09:50:04.4400942+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9836e34f-3350-4ac2-8fb0-6e3a23d55c3c",
"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": "29081007-af44-4d24-8603-1a7ea8d81534",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-11-21T09:50:04.4400942+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "00e60381-12b9-4a75-a344-f55fe6b203c6"
},
"suggested_date_start": "2024-11-21T09:50:04.4400942+00:00",
"skill_id": "aa4f9d12-8718-44b3-87b2-902284b4ffe9",
"skill_code": "sample string 32",
"skill": {
"id": "d246dbf5-c28a-40b8-bdd4-5f11be002717",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6073fdec-c464-4864-a3ac-397e80bc03e4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b7bc0e79-8750-4fdb-839f-2e780e539261",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c9b34ae-d202-433d-95e2-84dce0769a19",
"db_currency_id": "136d9c87-69b4-484b-ad34-ca7381c03829",
"db_language_id": "f41793b5-a408-4041-8456-001587b0cda0",
"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-11-21T09:50:04.4400942+00:00"
},
"modified_dateutc": "2024-11-21T09:50:04.4400942+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "653475b5-a0f4-4d6e-8cca-5c9171eca2ca",
"date_reported_by_company": "2024-11-21T09:50:04.4400942+00:00",
"id2": 36,
"company_id": "d2539585-0b4a-44ba-a625-94daf0c514b3",
"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": "1498bc24-992f-40e9-8611-1f7e6a25dab6",
"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-11-21T09:50:04.4400942+00:00"
},
"work_instruction_details_id": "0ee973e4-35bf-49b3-9149-bb9844bb30d8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7bb826fd-b1af-4439-80cb-0803702f94d9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d62148b9-c541-466c-8ddc-668452878c46",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-11-21T09:50:04.4400942+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": "f64f7214-acbf-4daa-83f5-fc2553a183c0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-11-21T09:50:04.4400942+00:00"
}