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": "1e3f66e9-a46c-42bd-8fc5-8ee4f2ee7d74",
"jobs_id": "426f5d78-486c-44fb-8caa-9740a0ed87ed",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9d019593-0df8-49a8-88ce-604175ee7645",
"_parent_id": "762c65ec-03a4-4600-9ed9-b8885a25ffe5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "06a3da83-c5d2-4753-ab0a-0cb3b1e70027",
"project_reference_back_office": "sample string 5",
"project": {
"id": "75e86a94-1fdc-4b88-a32f-7c172de1512f",
"_parent_id": "a98c4eb8-2f06-42a4-b389-1321259e59b8",
"root_parent_id": "001ba476-06eb-41f9-b332-f72116075bd0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9dd5417c-ec2b-43a5-9fdc-a811cf93e04f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8be5f781-d180-439f-b2df-c89be09e2f58",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc91ee45-c9d1-406b-bce7-53ba299508ad",
"_parent_code": "sample string 6",
"sales_organization_id": "02048912-99d0-4ab5-8095-6047c0ecae8d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "93f62608-e6e3-4ad6-b63a-b53fb5e0778a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d63c1fa-2a73-47bf-964a-d83e6bb59a12",
"db_currency_id": "944c7d41-9425-44eb-942e-7f7a8c13506c",
"db_language_id": "8e2f78ea-14a8-4ae4-97f2-a33af277a450",
"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-01-02T12:57:42.7954347+00:00"
},
"modified_dateutc": "2025-01-02T12:57:42.7954347+00:00"
},
"equipment_model_id": "d3ab86f8-f143-458b-bc9e-ce34d929cb46",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "268aabd5-941e-498d-954f-3d8149b210fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "37bea535-955c-4473-be8e-1e137a974a3d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "770a073d-7784-4592-a3c6-3fce378af021",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7a5bebea-95b1-45ff-9adb-a511443db7dc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "93f62608-e6e3-4ad6-b63a-b53fb5e0778a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d63c1fa-2a73-47bf-964a-d83e6bb59a12",
"db_currency_id": "944c7d41-9425-44eb-942e-7f7a8c13506c",
"db_language_id": "8e2f78ea-14a8-4ae4-97f2-a33af277a450",
"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-01-02T12:57:42.7954347+00:00"
},
"modified_dateutc": "2025-01-02T12:57:42.7954347+00:00"
},
"equipment_family_id": "6e2b39ce-7de9-4e1c-9d2d-545cb8b28b4f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8be5f781-d180-439f-b2df-c89be09e2f58",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc91ee45-c9d1-406b-bce7-53ba299508ad",
"_parent_code": "sample string 6",
"sales_organization_id": "02048912-99d0-4ab5-8095-6047c0ecae8d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "93f62608-e6e3-4ad6-b63a-b53fb5e0778a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d63c1fa-2a73-47bf-964a-d83e6bb59a12",
"db_currency_id": "944c7d41-9425-44eb-942e-7f7a8c13506c",
"db_language_id": "8e2f78ea-14a8-4ae4-97f2-a33af277a450",
"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-01-02T12:57:42.7954347+00:00"
},
"modified_dateutc": "2025-01-02T12:57:42.7954347+00:00"
},
"date_in_production_since": "2025-01-02T12:57:42.7954347+00:00",
"date_out_of_production_since": "2025-01-02T12:57:42.7954347+00:00",
"date_end_support": "2025-01-02T12:57:42.7954347+00:00",
"sales_organization_id": "aa4ad2e4-3e47-4ea6-a371-c3c61aeb43ca",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "93f62608-e6e3-4ad6-b63a-b53fb5e0778a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d63c1fa-2a73-47bf-964a-d83e6bb59a12",
"db_currency_id": "944c7d41-9425-44eb-942e-7f7a8c13506c",
"db_language_id": "8e2f78ea-14a8-4ae4-97f2-a33af277a450",
"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-01-02T12:57:42.7954347+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-01-02T12:57:42.7954347+00:00"
},
"project_status_id": "961c0ad9-d72b-4964-9315-3f955ace5e8a",
"project_status_code": "sample string 10",
"project_status": {
"id": "38f12127-41ac-4b9c-b583-a69e1797bcd4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "68052217-70a9-4149-840b-5b281f52d8e8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "93f62608-e6e3-4ad6-b63a-b53fb5e0778a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d63c1fa-2a73-47bf-964a-d83e6bb59a12",
"db_currency_id": "944c7d41-9425-44eb-942e-7f7a8c13506c",
"db_language_id": "8e2f78ea-14a8-4ae4-97f2-a33af277a450",
"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-01-02T12:57:42.7954347+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-01-02T12:57:42.7954347+00:00"
},
"company_id": "baaacbd9-2db8-445f-92fc-63782a8f7e36",
"company_code": "sample string 12",
"db_address_id": "8de5d7c7-b39d-4b8c-b97d-8bef621275ac",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8f7e891b-c392-4e7e-9225-e0bc9ff94a5f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9359c16a-cb13-4c77-afec-2f83cc309017",
"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-01-02T12:57:42.7954347+00:00",
"date_create": "2025-01-02T12:57:42.7954347+00:00",
"date_update": "2025-01-02T12:57:42.7954347+00:00",
"updated_by_user_id": "ac117cba-8da6-4a80-9837-e16714c2adda",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-01-02T12:57:42.7954347+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-01-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-01-02T12:57:42.7954347+00:00",
"date_last_job": "2025-01-02T12:57:42.7954347+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-01-02T12:57:42.7954347+00:00",
"modified_dateutc": "2025-01-02T12:57:42.7954347+00:00",
"is_mobile_installation": true
},
"job_type_id": "ae9b5b53-1d0d-4a8f-849a-d53761d07d86",
"job_type_code": "sample string 7",
"job_type": {
"id": "2ab11a16-5733-4c40-b13e-b16484c1a382",
"name": "sample string 2",
"sales_organization_id": "6ad8fb7e-620b-43c8-bb95-6b4df5238f5d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-01-02T12:57:42.7954347+00:00",
"code": "sample string 7"
},
"job_priority_id": "fefd5f70-7642-4e85-8e2a-dcab17806e65",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ff86a6c5-ff60-4867-b41c-7073cb77a719",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5d67a8b9-a869-4bf9-ad57-bacdd8eba5ff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "93f62608-e6e3-4ad6-b63a-b53fb5e0778a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d63c1fa-2a73-47bf-964a-d83e6bb59a12",
"db_currency_id": "944c7d41-9425-44eb-942e-7f7a8c13506c",
"db_language_id": "8e2f78ea-14a8-4ae4-97f2-a33af277a450",
"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-01-02T12:57:42.7954347+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-01-02T12:57:42.7954347+00:00"
},
"job_status_id": "0e5fce08-dd1c-43e7-986a-42e69588d2b1",
"job_status_code": "sample string 11",
"db_address_id": "4cd848a8-26d8-4657-9ceb-1614e1d66ab8",
"contact_id": "f2a17f9a-2476-40b6-aa0e-f0104952ef34",
"requested_by_company_id": "0b97711b-28bb-444d-8eab-e69c981de1cf",
"requested_by_contact_id": "9c00ce8b-47b0-4670-b098-8cffd3f79463",
"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-01-02T12:57:42.7954347+00:00",
"due_date": "2025-01-02T12:57:42.7954347+00:00",
"date_create": "2025-01-02T12:57:42.7954347+00:00",
"date_update": "2025-01-02T12:57:42.7954347+00:00",
"date_closed": "2025-01-02T12:57:42.7954347+00:00",
"suggested_user_id": "6037437c-2cab-433a-aa53-87d8f3ccc038",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9fd948ac-a003-408e-8a58-a1b4a26fb416",
"db_language_id": "af2fbdb4-4f30-465c-be6c-1e2f301aa4c4",
"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-01-02T12:57:42.7954347+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c965813f-32f0-412e-87f0-3f5312f5bd93",
"sales_organization": {
"id": "93f62608-e6e3-4ad6-b63a-b53fb5e0778a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d63c1fa-2a73-47bf-964a-d83e6bb59a12",
"db_currency_id": "944c7d41-9425-44eb-942e-7f7a8c13506c",
"db_language_id": "8e2f78ea-14a8-4ae4-97f2-a33af277a450",
"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-01-02T12:57:42.7954347+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c4ad5c1b-07b9-4576-bdab-65e53298ca65",
"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": "ba972e02-aacb-4a00-8b87-55e9184f786c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-01-02T12:57:42.8110581+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9a4e455b-795d-45f6-a050-c6fd0f9668f7"
},
"suggested_date_start": "2025-01-02T12:57:42.8110581+00:00",
"skill_id": "6e47abfa-342c-4423-9fce-f5d32f2fe97d",
"skill_code": "sample string 32",
"skill": {
"id": "80a2a029-23ca-4a71-8d43-7cb8ec3752db",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1edcc078-e6fb-41af-a8ba-a58b7c3a2e15",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "93f62608-e6e3-4ad6-b63a-b53fb5e0778a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d63c1fa-2a73-47bf-964a-d83e6bb59a12",
"db_currency_id": "944c7d41-9425-44eb-942e-7f7a8c13506c",
"db_language_id": "8e2f78ea-14a8-4ae4-97f2-a33af277a450",
"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-01-02T12:57:42.7954347+00:00"
},
"modified_dateutc": "2025-01-02T12:57:42.8110581+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "48b36647-5ed0-453a-a762-2e7e47057d29",
"date_reported_by_company": "2025-01-02T12:57:42.8110581+00:00",
"id2": 36,
"company_id": "4a568760-0e61-45e1-9f9c-b7c7acd57df0",
"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": "d07e7a29-de6d-4417-b07a-26634163c200",
"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-01-02T12:57:42.8110581+00:00"
},
"work_instruction_details_id": "dde2a72f-d695-4217-a96e-63b0eae7fad0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "26639c1b-c1ae-46d7-866c-64a15381f41f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ec464ad1-d9f8-4778-bf54-f736c82cdc32",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-01-02T12:57:42.8110581+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": "9edd6e09-d819-4980-8cdf-ce704d91cb9f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-01-02T12:57:42.8110581+00:00"
}