{ "opencollection": "1.0.0", "info": { "name": "Rest Activity Package API", "version": "Platform.v2026.2.0.0.20260708" }, "items": [ { "info": { "name": "Package", "type": "folder" }, "items": [ { "info": { "name": "Enviance.RestServices.Ver2.Packages.Impl.PackageService.CreatePackage", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ver2/PackageService.svc/packages", "headers": [ { "name": "EnvApi-Systemid", "value": "" }, { "name": "EnvApi-Packageid", "value": "" }, { "name": "EnvApi-Udf-DateTime-Iso-In-CustomFields", "value": "" }, { "name": "EnvApi-Udf-DateTime-ReadInUserTz", "value": "" }, { "name": "EnvApi-Udf-Value-Invariant", "value": "" }, { "name": "EnvApi-Localization-All", "value": "" }, { "name": "x-client-request-id", "value": "" } ] }, "docs": "\n\n\nenvianceSdk.packages.createPackage\r\n```\r\n[\r\n {\r\n \"name\": \"Tracker 001\",\r\n \"description\": \"Incident tracking and management.\",\r\n \"displayPage\": \"/index.html\",\r\n \"iconSrc\": \"/imgs/icon.png\",\r\n \"isLocked\": \"false\"\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.packages.createPackageItem\r\n```\r\n[\r\n \"Tracker 001\",\r\n {\r\n \"package\": \"p1\",\r\n \"path\": \"p1.htm\",\r\n \"content\": \"77u/IkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0LCBjb25zZWN0ZXR1ciBhZGlwaXNpY2luZyBlbGl0LCBzZWQgZG8gZW" }, { "info": { "name": "Enviance.RestServices.Ver2.Packages.Impl.PackageService.GetPackage", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ver2/PackageService.svc/packages/:packageIdOrName", "headers": [ { "name": "EnvApi-Systemid", "value": "" }, { "name": "EnvApi-Packageid", "value": "" }, { "name": "EnvApi-Udf-DateTime-Iso-In-CustomFields", "value": "" }, { "name": "EnvApi-Udf-DateTime-ReadInUserTz", "value": "" }, { "name": "EnvApi-Udf-Value-Invariant", "value": "" }, { "name": "EnvApi-Localization-All", "value": "" }, { "name": "x-client-request-id", "value": "" } ], "params": [ { "name": "packageIdOrName", "value": "", "type": "path" } ] }, "docs": "\n\n\nenvianceSdk.packages.getPackage\r\n```\r\n[\r\n \"Tracker 001\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.packages.getPackageItem\r\n```\r\n[\r\n \"Tracker 001\",\r\n \"p1.htm\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.packages.getPackageAppData\r\n```\r\n[\r\n \"Tracker 001\",\r\n \"key1\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\n[\"ApplicationID\", \"someKey\", \"onsuccess\", \"onerror\"] // Expected value should be valid JSON, not scalar value or string\n" }, { "info": { "name": "Enviance.RestServices.Ver2.Packages.Impl.PackageService.UpdatePackage", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ver2/PackageService.svc/packages/:packageIdOrName", "headers": [ { "name": "EnvApi-Systemid", "value": "" }, { "name": "EnvApi-Packageid", "value": "" }, { "name": "EnvApi-Udf-DateTime-Iso-In-CustomFields", "value": "" }, { "name": "EnvApi-Udf-DateTime-ReadInUserTz", "value": "" }, { "name": "EnvApi-Udf-Value-Invariant", "value": "" }, { "name": "EnvApi-Localization-All", "value": "" }, { "name": "x-client-request-id", "value": "" } ], "params": [ { "name": "packageIdOrName", "value": "", "type": "path" } ] }, "docs": "\n\nUpdates an existing Enviance App (package).\r\n\r\n**Security:** Requires Manage Enviance Apps system right.\r\n\r\n**SDK API:** `envianceSdk.packages.updatePackage(packageIdOrName, packageInfo, onsuccess, onerror)`\r\n\r\n```\r\nPATCH /ver2/PackageService.svc/packages/bdba60aa-cb36-43bf-ba2e-7532c49968d0 HTTP/1.1\r\n \r\n{\r\n \"packageInfo\": {\r\n \"name\": \"Incident Tracker\",\r\n \"description\": \"Incident tracking and management.\",\r\n \"content\": \"UEsDBBQABgAIAAAAIQCMGvGG3QEAAFMIAAATAAgCW0NvbnRlbnRfVHlwZXNdLn" }, { "info": { "name": "Enviance.RestServices.Ver2.Packages.Impl.PackageService.DeletePackage", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ver2/PackageService.svc/packages/:packageIdOrName", "headers": [ { "name": "EnvApi-Systemid", "value": "" }, { "name": "EnvApi-Packageid", "value": "" }, { "name": "EnvApi-Udf-DateTime-Iso-In-CustomFields", "value": "" }, { "name": "EnvApi-Udf-DateTime-ReadInUserTz", "value": "" }, { "name": "EnvApi-Udf-Value-Invariant", "value": "" }, { "name": "EnvApi-Localization-All", "value": "" }, { "name": "x-client-request-id", "value": "" } ], "params": [ { "name": "packageIdOrName", "value": "", "type": "path" } ] }, "docs": "\n\n\nenvianceSdk.packages.deletePackage\r\n```\r\n[\r\n \"Tracker 001\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.packages.deletePackageItem\r\n```\r\n[\r\n \"Tracker 001\",\r\n \"p1.htm\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.packages.deletePackageAppData\r\n```\r\n[\r\n \"Tracker 001\",\r\n \"key1\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\n\n" }, { "info": { "name": "Enviance.RestServices.Ver2.Packages.Impl.PackageService.GetPackageAppData", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ver2/PackageService.svc/packages/:packageIdOrName/data/:key", "headers": [ { "name": "EnvApi-Systemid", "value": "" }, { "name": "EnvApi-Packageid", "value": "" }, { "name": "EnvApi-Udf-DateTime-Iso-In-CustomFields", "value": "" }, { "name": "EnvApi-Udf-DateTime-ReadInUserTz", "value": "" }, { "name": "EnvApi-Udf-Value-Invariant", "value": "" }, { "name": "EnvApi-Localization-All", "value": "" }, { "name": "x-client-request-id", "value": "" } ], "params": [ { "name": "packageIdOrName", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "path" }, { "name": "dtype", "value": "", "type": "query" } ] }, "docs": "\n\nRetrieves an existing Enviance App (Package) data key-value pair, using the specified unique key. If user does not have permissions to retrieve data it returns empty string. No Errors thrown.\r\n\r\n**Security:** Requires Manage Enviance Apps system right.\r\n\r\n**SDK API:** `envianceSdk.packages.getPackageAppData(packageIdOrName, key, onsuccess, onerror)`\r\n\r\n```\r\nGET /ver2/PackageService.svc/packages/Incident%20Tracker HTTP/1.1\r\n\r\n//RESPONSE\r\n{\r\n \"id\": \"4657bd77-fced-42be-a491-d63a59c42a4c\",\r\n \"n" }, { "info": { "name": "Enviance.RestServices.Ver2.Packages.Impl.PackageService.SavePackageAppData", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ver2/PackageService.svc/packages/:packageIdOrName/data/:key", "headers": [ { "name": "EnvApi-Systemid", "value": "" }, { "name": "EnvApi-Packageid", "value": "" }, { "name": "EnvApi-Udf-DateTime-Iso-In-CustomFields", "value": "" }, { "name": "EnvApi-Udf-DateTime-ReadInUserTz", "value": "" }, { "name": "EnvApi-Udf-Value-Invariant", "value": "" }, { "name": "EnvApi-Localization-All", "value": "" }, { "name": "x-client-request-id", "value": "" } ], "params": [ { "name": "packageIdOrName", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "path" } ] }, "docs": "\n\n\nenvianceSdk.packages.savePackageAppData\r\n```\r\n[\r\n \"Tracker 001\",\r\n \"key1\",\r\n \"value-101010\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.packages.savePackageAppDataJson\r\n```\r\n[\r\n \"ApplicationID\",\r\n \"someKey\",\r\n {\r\n \"field1\": 1,\r\n \"field2\": \"someText\"\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\n\n" }, { "info": { "name": "Enviance.RestServices.Ver2.Packages.Impl.PackageService.DeletePackageAppData", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ver2/PackageService.svc/packages/:packageIdOrName/data/:key", "headers": [ { "name": "EnvApi-Systemid", "value": "" }, { "name": "EnvApi-Packageid", "value": "" }, { "name": "EnvApi-Udf-DateTime-Iso-In-CustomFields", "value": "" }, { "name": "EnvApi-Udf-DateTime-ReadInUserTz", "value": "" }, { "name": "EnvApi-Udf-Value-Invariant", "value": "" }, { "name": "EnvApi-Localization-All", "value": "" }, { "name": "x-client-request-id", "value": "" } ], "params": [ { "name": "packageIdOrName", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "path" } ] }, "docs": "\n\n\nenvianceSdk.packages.deletePackageAppData\r\n```\r\n[\r\n \"Tracker 001\",\r\n \"key1\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\n\n" }, { "info": { "name": "Enviance.RestServices.Ver2.Packages.Impl.PackageService.CreatePackageItem", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ver2/PackageService.svc/packages/:packageIdOrName/items", "headers": [ { "name": "EnvApi-Systemid", "value": "" }, { "name": "EnvApi-Packageid", "value": "" }, { "name": "EnvApi-Udf-DateTime-Iso-In-CustomFields", "value": "" }, { "name": "EnvApi-Udf-DateTime-ReadInUserTz", "value": "" }, { "name": "EnvApi-Udf-Value-Invariant", "value": "" }, { "name": "EnvApi-Localization-All", "value": "" }, { "name": "x-client-request-id", "value": "" } ], "params": [ { "name": "packageIdOrName", "value": "", "type": "path" } ] }, "docs": "\n\n\nenvianceSdk.packages.createPackageItem\r\n```\r\n[\r\n \"Tracker 001\",\r\n {\r\n \"package\": \"p1\",\r\n \"path\": \"p1.htm\",\r\n \"content\": \"77u/IkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0LCBjb25zZWN0ZXR1ciBhZGlwaXNpY2luZyBlbGl0LCBzZWQgZG8gZWl1c21vZCB0ZW1wb3IgaW5jaWRpZHVudCB1dCBsYWJvcmUgZXQgZG9sb3JlIG1hZ25hIGFsaXF1YS4gVXQgZW5pbSBhZCBtaW5pbSB2ZW5pYW0sIHF1aXMgbm9zdHJ1ZCBleGVyY2l0YXRpb24gdWxsYW1jbyBsYWJvcmlzIG5pc2kgdXQgYWxpcXVpcCBleCBlYSBjb21tb2RvIGNvbnNlcXVhdC4gRHVpcyBhdXRlIGlydXJlIGRvbG9yIGluIHJlcHJlaGVuZGVya" }, { "info": { "name": "Enviance.RestServices.Ver2.Packages.Impl.PackageService.GetPackageItem", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ver2/PackageService.svc/packages/:packageIdOrName/items/:itemIdOrPath", "headers": [ { "name": "EnvApi-Systemid", "value": "" }, { "name": "EnvApi-Packageid", "value": "" }, { "name": "EnvApi-Udf-DateTime-Iso-In-CustomFields", "value": "" }, { "name": "EnvApi-Udf-DateTime-ReadInUserTz", "value": "" }, { "name": "EnvApi-Udf-Value-Invariant", "value": "" }, { "name": "EnvApi-Localization-All", "value": "" }, { "name": "x-client-request-id", "value": "" } ], "params": [ { "name": "packageIdOrName", "value": "", "type": "path" }, { "name": "itemIdOrPath", "value": "", "type": "path" } ] }, "docs": "\n\n\nenvianceSdk.packages.getPackageItem\r\n```\r\n[\r\n \"Tracker 001\",\r\n \"p1.htm\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\n\n" }, { "info": { "name": "Enviance.RestServices.Ver2.Packages.Impl.PackageService.UpdatePackageItem", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ver2/PackageService.svc/packages/:packageIdOrName/items/:itemIdOrPath", "headers": [ { "name": "EnvApi-Systemid", "value": "" }, { "name": "EnvApi-Packageid", "value": "" }, { "name": "EnvApi-Udf-DateTime-Iso-In-CustomFields", "value": "" }, { "name": "EnvApi-Udf-DateTime-ReadInUserTz", "value": "" }, { "name": "EnvApi-Udf-Value-Invariant", "value": "" }, { "name": "EnvApi-Localization-All", "value": "" }, { "name": "x-client-request-id", "value": "" } ], "params": [ { "name": "packageIdOrName", "value": "", "type": "path" }, { "name": "itemIdOrPath", "value": "", "type": "path" } ] }, "docs": "\n\n\nenvianceSdk.packages.updatePackageItem\r\n```\r\n[\r\n \"Tracker 001\",\r\n \"p1.htm\",\r\n {\r\n \"package\": \"p1\",\r\n \"path\": \"p1.htm\",\r\n \"content\": \"77u/IkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0LCBjb25zZWN0ZXR1ciBhZGlwaXNpY2luZyBlbGl0LCBzZWQgZG8gZWl1c21vZCB0ZW1wb3IgaW5jaWRpZHVudCB1dCBsYWJvcmUgZXQgZG9sb3JlIG1hZ25hIGFsaXF1YS4gVXQgZW5pbSBhZCBtaW5pbSB2ZW5pYW0sIHF1aXMgbm9zdHJ1ZCBleGVyY2l0YXRpb24gdWxsYW1jbyBsYWJvcmlzIG5pc2kgdXQgYWxpcXVpcCBleCBlYSBjb21tb2RvIGNvbnNlcXVhdC4gRHVpcyBhdXRlIGlydXJlIGRvbG9yIGluIHJl" }, { "info": { "name": "Enviance.RestServices.Ver2.Packages.Impl.PackageService.DeletePackageItem", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ver2/PackageService.svc/packages/:packageIdOrName/items/:itemIdOrPath", "headers": [ { "name": "EnvApi-Systemid", "value": "" }, { "name": "EnvApi-Packageid", "value": "" }, { "name": "EnvApi-Udf-DateTime-Iso-In-CustomFields", "value": "" }, { "name": "EnvApi-Udf-DateTime-ReadInUserTz", "value": "" }, { "name": "EnvApi-Udf-Value-Invariant", "value": "" }, { "name": "EnvApi-Localization-All", "value": "" }, { "name": "x-client-request-id", "value": "" } ], "params": [ { "name": "packageIdOrName", "value": "", "type": "path" }, { "name": "itemIdOrPath", "value": "", "type": "path" } ] }, "docs": "\n\n\nenvianceSdk.packages.deletePackageItem\r\n```\r\n[\r\n \"Tracker 001\",\r\n \"p1.htm\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\n\n" } ] } ], "bundled": true }