Represents a specific version of a marketplace package with release notes, deprecation status, minimum system requirements, and FIT script definitions.
Overview of MarketplacePackageVersionInfo goes here.
Item -> BaseInfo -> MarketplaceObjectInfo -> MarketplacePackageVersionInfo
| Field | Type | Inherited from | Description |
|---|---|---|---|
| Href | String | Item | Gets or sets the href. |
| CommonName | String | BaseInfo | Common Name of the resource.The common name of the resource. |
| ConcurrencyVersion | Nullable<Int64> | BaseInfo | Gets or Set the Version. |
| InFolderHref | String | BaseInfo | relative path Href value for the containing folderAll objects exist within a folder. Even folders! |
| InFolderKey | String | BaseInfo | Represents the internal ID of the containing folder |
| IsGlobal | Boolean | BaseInfo | If set True, the object will be exposed to the entire instance scope in which it resides. Meaning this object will always pass scope wide permissions tests when being queried although other restrictions such as by type will still apply (You need at least Read on the object type to see it regardless where you are in the instance scope). This Attribute is intended for use with AccessLevelInfo objects only. Use with other model objects may cause unexpected behaviors. Particularly this should not be used with ScheduleInfos, HolidayInfos, HolidayDayInfos, or ElevatorAccessLevelInfos. In time more objects will be allowed for use with this attribute but for the time being please only use with AccessLevelInfo Objects. |
| Key | String | BaseInfo | Represents the internal ID of the object. |
| Links | List<Link> | BaseInfo | List of related resourcesIt is expected that a resource will have many related resources (i.e. person has many access levels) Consumers of the API are encouraged to iterate through the list of links requesting this additional information as required. |
| Metadata | MetadataItem[] | BaseInfo | The set of metadata attached to this resourceMetadata is opaque to the server code. Key value pairs are saved as part of a client activity. Users of the Native windows client, are able to design custom forms to display and edit scalar values in the meta data. |
| Monikers | MonikerItem[] | BaseInfo | the set of Monikers for this object |
| Notes | NoteInfo[] | BaseInfo | The set of notes attached to this resourceNotes are free form text only that is stored in chronological order. All notes are retrieved as part of an OBJECT get. Notes may be added as one POST but not updated with a PUT of the primary resource. WHen the resource is deleted all the notes are also deleted. |
| ObjectLinks | ObjectLinkItem[] | BaseInfo | The set of resources that are related to this resource. Frequently resources have a one to one, or one to many relationship with other resources in the system. Use this set of links to discover related resources. 2016/09/29 Href property of the related resource may be null. In which case it’s expected that a set of related objects has already been retrieved by the client and the Key value will be used to index into that set. |
| Tags | String[] | BaseInfo | the set of tags for this object. Tags are used to group objects together for the purposes of selection and assignment of operation rights. |
| LongDescription | String | MarketplaceObjectInfo | Gets or sets the long description. |
| ShortDescription | String | MarketplaceObjectInfo | Gets or sets the short description/headline. |
| Authors | String[] | MarketplacePackageVersionInfo | Gets or sets the list of authors. |
| GalleryPoints | Nullable<Int32> | MarketplacePackageVersionInfo | Gets or sets the gallery points. |
| IsDeprecated | Boolean | MarketplacePackageVersionInfo | Gets or sets the isDeprecated flag. |
| Number | String | MarketplacePackageVersionInfo | Gets or sets the version number. |
| ReleaseDate | DateTime | MarketplacePackageVersionInfo | Gets or sets the release date. |
| ReleaseNotes | String | MarketplacePackageVersionInfo | Gets or sets the release notes. |
{
"Href" : "String",
"CommonName" : "String",
"ConcurrencyVersion" : "Nullable\<Int64\>",
"InFolderHref" : "String",
"InFolderKey" : "String",
"IsGlobal" : "Boolean",
"Key" : "String",
"Links" : "List\<[Link](/object-model/link)\>",
"Metadata" : "[MetadataItem](/object-model/metadataitem)[]",
"Monikers" : "[MonikerItem](/object-model/monikeritem)[]",
"Notes" : "[NoteInfo](/object-model/noteinfo)[]",
"ObjectLinks" : "[ObjectLinkItem](/object-model/objectlinkitem)[]",
"Tags" : "String[]",
"LongDescription" : "String",
"ShortDescription" : "String",
"Authors" : "String[]",
"GalleryPoints" : "Nullable\<Int32\>",
"IsDeprecated" : "Boolean",
"Number" : "String",
"ReleaseDate" : "DateTime",
"ReleaseNotes" : "String"
}
Example in C#
// Returns: MarketplacePackageVersionInfo
var marketplacePackageVersionInfo = await client.AddMarketplacePackageVersionAsync(FolderInfo folder, MarketplacePackageVersionInfo item);
Example in CURL
curl -X POST \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/MarketplacePackageVersions \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '{
"$type":"Feenics.Keep.WebApi.Model.MarketplacePackageVersionInfo, Feenics.Keep.WebApi.Model",
"Number":"1.0.0",
"ReleaseNotes":"Initial release",
"IsDeprecated":false,
"ShortDescription":"Short description of package for display",
"LongDescription":"Long description of package",
"Authors":["Author"],
"ReleaseDate":DATETIME,
"GalleryPoints": 100,
"CommonName":"Version 1.0.0 of MarketplacePackage PackageName"
"ObjectLinks":[
{
"$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
"Href":null,
"LinkedObjectKey":"MarketplacePackage_KEY",
"CommonName":"MARKETPLACEPACKAGE_NAME",
"Relation":"Package",
"MetaDataBson":
{
"$type":"System.Byte[], mscorlib",
"$value":""
}
}
],
"Metadata":null,
"Notes":null,
"Tags":["report"],
"Monikers":null,
"Href":null
}'
Example in C#
// Returns: nothing
await client.DeleteMarketplacePackageVersionAsync(MarketplacePackageVersionInfo item);
Example in CURL
curl -X DELETE \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/MarketplacePackageVersions/MarketplacePackageVersion.Key \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
Example in C#
// Returns: MarketplacePackageVersionInfo
var marketplacePackageVersionInfo = await client.GetMarketplacePackageVersionByIdAsnyc(FolderInfo folder, String id, Boolean includeParentFolders, Boolean includeChildrenFolders);
Example in CURL
curl -X GET \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/MarketplacePackageVersions/MarketplacePackageVersion.Key?includeParentFolders=false;includeChildrenFolders=false \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: IEnumerable<MarketplacePackageVersionInfo>
var marketplacePackageVersionInfo = await client.GetMarketplacePackageVersionsAsync(FolderInfo folder, String packageId, String packageName, String versionNumber, Boolean includeChildrenFolders, Boolean includeParentFolders, Boolean onlyChildrenFolders);
Example in CURL
curl -X GET \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/MarketplacePackageVersions?packageId=1;packageName=examplePackage;versionNumber=24.11.1;includeChildrenFolders=false;includeParentFolders=false;onlyChildrenFolders=false \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: nothing
await client.UpdateMarketplacePackageVersionAsync(MarketplacePackageVersionInfo item);
Example in CURL
curl -X POST \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/MarketplacePackageVersions \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '{
"$type":"Feenics.Keep.WebApi.Model.MarketplacePackageVersionInfo, Feenics.Keep.WebApi.Model",
"ReleaseDate":DATETIME,
}'