FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE

FlexNet Operations Web Services Guide

Elements: ESDService

Elements
Name  Description 
acceptComplianceAgreementRequest  An acceptComplianceAgreementRequest message contains an element of acceptComplianceAgreement.
acceptComplianceAgreementResponse  An acceptComplianceAgreementResponse message contains an element of checkDownloadPackages.
acceptEULARequest  An acceptEULARequest message contains an element of acceptEULA.
acceptEULAResponse   
ActivationId [element checkDownloadPackagesRequest]  Activation ID.
ActivationId [element checkDownloadPackagesResponse]  Activation ID.
ActivationId [element getDownloadPackageNameRequest]  Activation ID.
ActivationId [element getDownloadPackagesByActivationIdsRequest]  Activation ID.
ActivationId [type RequestByPrincipal]  Activation ID.
AdvancedDownloadProperties [type DownloadableFile]  The advanced download properties for the downloadable file.
Agreement [element getComplianceAgreementResponse]  Compliance Agreement.
apiVersion [type ChartVersion]  API version.
archiveDateTimestamp [element getImagesAndChartsResponse]  Archive date.
ArchivedDownloadPackage [element getDownloadPackagesByActivationIdsResponse]  Archived Download Package.
ArchivedDownloadPackage [element getDownloadPackagesResponse]  Archived Download Package.
artifactCount [type Repository]  Artifact count.
ArtifactRequestParam [element getImagesAndChartsRequest]  Artifact request param.
Artifacts [type Repository]  An artifact pushed to a registry for a Download Package that supports Software Container Delivery. Possible artifacts are Docker images and Helm charts.
Ascending [element getDownloadableFilesRequest]  Flag indicating whether files in the request are sorted in ascending order.
Ascending [element getDownloadableFilesResponse]  Flag indicating whether files in the response are sorted in ascending order.
Ascending [element getFilesByDownloadPackagesResponse]  Flag indicating whether files in the response are sorted in ascending order.
Ascending [type DownloadPackageSortBy]  Flag indicating whether files in the Download Package are sorted in ascending order.
Ascending [type FilesSortBy]  Flag indicating whether files are sorted in ascending order.
AuthenticationProblem  A problem occurring when authenticating an API call.
Availability [type DownloadPackageQueryParameters]  Availability (defaults to Current).
BatchSize [element getDownloadPackagesByActivationIdsRequest]  Batch Size.
BatchSize [element getFilesByDownloadPackagesRequest]  Batch Size.
CDRequestLink [type DownloadableFile]  URL for media requests.
Charts [element getImagesAndChartsResponse]  Charts.
chartVersion [type Chart]  Chart version.
checkDownloadPackagesRequest  A checkDownloadPackagesRequest message contains an element of checkDownloadPackages.
checkDownloadPackagesResponse  A checkDownloadPackagesResponse message contains an element of checkDownloadPackages.
Code [type UnexpectedError]  Code.
CompletedDownloadCount [type DownloadableFile]  The number of the completed downloads.
ComplianceAgreementIsNotAcceptedError  An error indicating that a Download Package's compliance agreement has not been accepted.
CompressedSize [type DownloadableFile]  Compressed size.
Content [element getContentResponse]  HTML Content.
Content [type UserDefinedField]  Custom attribute value.
contentId [element getContentRequest]  content ID.
created [type ChartVersion]  The date the Helm chart was created.
creationTime [type Repository]  Creation time.
Critical [type UploadedFile]  Flag indicating if it's critical.
CriticalUdfName [element getRecentUploadedFilesResponse] 

Critical Custom Attribute name.

Note:

When request's "includeCriticalUdf" flag is "true" and "ViewRecentUploadFiles.UDF.Critical" property is set for the partner, the value of this property is returned.

CurrentDownloadPackage [element getDownloadPackagesByActivationIdsResponse]  Current Download Packages.
CurrentDownloadPackage [element getDownloadPackagesResponse]  Current Download Packages.
debugMsg [type RegistryServiceError]  Debug message.
description [type ChartVersion]  Chart version description.
Description [type DownloadableFile]  Description for the Downloadable file.
Description [type DownloadPackage]  Description for the Download Package.
description [type Repository]  Description for the repository.
Description [type UdfValue]  UDF value description.
details [type RegistryServiceError]  Registery service error details.
digest [type Artifact]  Artifact digest.
digest [type ChartVersion]  Chart version digest.
DocumentName [element getContentResponse]  HTML Content name.
DownloadableFile [element getDownloadLogResponse]  Downloadable file.
DownloadableFile [element getFileDownloadsResponse]  Downloadable file.
DownloadableFileCount [type DownloadPackage]  Downladable file count.
DownloadableFileList [element getAllFilesForPackageResponse]  List of downloadable files.
DownloadableFileList [element getDownloadableFilesResponse]  List of downloadable files.
DownloadableFileList [element getFilesByDownloadPackagesResponse]  List of downloadable files.
DownloadableFileReferences [type DownloadPackage]  The identifiers for a downloadable file.
DownloadImageUpdateDate [type DownloadableFile]  The date of the last file change.
DownloadInstructions [type DownloadPackage]  Download instruction for the Download Package.
DownloadMethod [type DownloadableFile]  File download method for a downloadable file.
DownloadMethod [type FileDownloadLog]  File download method for a file download log.
DownloadPackage [element getDownloadableFilesResponse]  The identifiers for a Download Package.
DownloadPackage [element getFilesByDownloadPackagesResponse]  The identifiers for a Download Package.
DownloadPackage [element getRecentDownloadPackagesResponse]  The identifiers for a Download Package.
DownloadPackage [element searchDownloadPackagesResponse]  The identifiers for a Download Package.
DownloadPackage [type ComplianceAgreementIsNotAcceptedError]  The identifiers for a Download Package.
DownloadPackage [type EULAIsNotAcceptedError]  The identifiers for a Download Package.
downloadPackageAvailability [element getImagesAndChartsResponse]  Download package availability.
DownloadPackageId [element getDownloadPackageInfoRequest]  Download Package ID.
DownloadPackageId [element getDownloadPackageNameResponse]  Download Package ID.
downloadPackageId [element getImagesAndChartsRequest]  Download Package ID.
downloadPackageId [element getImagesAndChartsResponse]  Download Package ID.
downloadPackageName [element getImagesAndChartsResponse]  Download Package name
DownloadPackageQueryParameters [element getDownloadPackagesByActivationIdsRequest]  Download Package query parameters.
DownloadPackageReference [element acceptComplianceAgreementRequest]  The identifiers for a Download Package.
DownloadPackageReference [element acceptEULARequest]  The identifiers for a Download Package.
DownloadPackageReference [element getAllFilesForPackageRequest]  The identifiers for a Download Package.
DownloadPackageReference [element getComplianceAgreementRequest]  The identifiers for a Download Package.
DownloadPackageReference [element getDownloadableFilesRequest]  The identifiers for a Download Package.
DownloadPackageReference [element getDownloadedFilesLogRequest]  The identifiers for a Download Package.
DownloadPackageReference [element getDownloadPackageNotificationsRequest]  The identifiers for a Download Package.
DownloadPackageReference [element getEULARequest]  The identifiers for a Download Package.
DownloadPackageReference [element getFilesByDownloadPackagesRequest]  The identifiers for a Download Package.
DownloadPackageReference [type DownloadableFile]  The identifiers for a Download Package.
DownloadPackages [type DownloadPackageVersion]  The identifiers for Download Packages.
DownloadPackageVersions [type ProductLine]  Download Package versions.
DownloadPrivilegeError  DownloadPrivilegeError is thrown when a user has no Download privileges.
DownloadURL [type DownloadableFile]  Download URL of a downloadable file.
EffectiveDate [type DownloadPackage]  Effective date of a Download Package.
effectiveDateTimestamp [element getImagesAndChartsResponse]  Timestamp representing the date the images and charts were effective.
email [type Maintainer]  Email address of the maintainer.
Email [type Member]  Email address of the member.
emailNoticeId [element getDownloadableFilesRequest]  Email notice ID (if user got to the page by following email link).
emailNoticeId [element getDownloadableFilesResponse]  Email notice ID (if user got to the page by following email link).
emailNoticeId [element getFilesByDownloadPackagesResponse]  Email notice ID (if user got to the page by following email link).
EmailReference [element getDownloadPackageNoticeDetailsRequest]  The identifiers for an email.
EndDateTime [type FileDownloadLog]  The end date and time for a file download log.
EntitlementId [type RequestByPrincipal]  Entitlement ID.
EULA [element getEULAResponse]  EULA.
EULAIsNotAcceptedError 

The EULAIsNotAcceptedError is shown when the EULA is required and has not been accepted.

NOTE: The getDownloadableFiles and getFilesByDownloadPackages APIs throw a EULAIsNotAcceptedError error if the user does not accept the EULA. Each EULA is for a single package, and therefore the error will be thrown per package. We recommend calling this method separately for each download package

EULARequired [element getDownloadableFilesRequest]  Flag indicating whether EULA is required.
EULARequired [element getFilesByDownloadPackagesRequest]  Flag indicating whether EULA is required.
ExecuteUponDownload [type DownloadableFile]  Flag indicating whether to execute the file upon download.
expirationDateTimestamp [element getImagesAndChartsResponse]  Timestamp representing the expiration date the images and charts.
ExportComplianceError  An ExportComplianceError is thrown when export compliance check for the Download Package fails.
ExportComplianceRequired [element getFilesByDownloadPackagesRequest]  Flag indicating whether export compliance is required.
exportDisclaimer [element getEULAResponse]  The content of export disclaimer.
ExtendedDescr [type DownloadPackage]  Extended description.
extendedDescription [element getImagesAndChartsResponse]  Extended description.
ExtendedDescription [type DownloadableFile]  Extended description.
ExternalURL [type DownloadableFile]  If the External delivery source is selected, the URL where the file is located.
File [element getDownloadedFilesLogResponse] 

File

  • system id

  • file name

  • description

  • file update date

File [element searchDownloadableFilesResponse] 

File

  • system id

  • file name

  • description

  • file update date

File [type UploadedFile] 

File

  • system id

  • file name

  • description

  • file update date

FileDownloadLog [element getDownloadLogResponse]  File download log.
FileDownloadLog [element getFileDownloadsResponse]  File download log.
FileDownloadLogId [element getDownloadLogRequest]  File download log ID.
FileDownloadLogId [type FileDownloadLog]  File download log ID.
FileGroups [element getDownloadableFilesResponse]  Downloadable files grouped under a group ID.
FileGroups [element getFilesByDownloadPackagesResponse]  Group of files.
FileId [type DownloadableFileReference]  File ID.
FileName [type DownloadableFile]  File Name.
FileReference [element getDownloadableFilesRequest]  See DownloadableFileReference.
FileReference [element getDownloadLogRequest]  File reference.
FileReference [element getFileDownloadsRequest]  File reference.
Files [type DownloadableFilesGroup]  Files.
FilesQueryParameters [element getFilesByDownloadPackagesRequest]  Files query parameters.
FirstName [type Member]  First name of the member.
flexeraContent [element getContentRequest]  Flexera Content.
getAllFilesForPackageRequest  A getAllFilesForPackageRequest message contains an element of getAllFilesForPackage.
getAllFilesForPackageResponse  A getAllFilesForPackageResponse message contains an element of getAllFilesForPackage.
getComplianceAgreementRequest  A getComplianceAgreementRequest message contains an element of getComplianceAgreement.
getComplianceAgreementResponse  A getComplianceAgreementResponse message contains an element of getComplianceAgreement.
getContentRequest  A getContentRequest message contains an element of getContent.
getContentResponse  A getContentResponse message contains an element of getContent.
getDownloadableFilesRequest  A getDownloadableFilesRequest message contains an element of getDownloadableFiles.
getDownloadableFilesResponse  A getDownloadableFilesResponse message contains an element of getDownloadableFiles.
getDownloadedFilesLogRequest  A getDownloadedFilesLogRequest message contains an element of getDownloadedFilesLog.
getDownloadedFilesLogResponse  A getDownloadedFilesLogResponse message contains an element of getDownloadedFilesLog.
getDownloadLogRequest  A getDownloadLogRequest message contains an element of getDownloadLog.
getDownloadLogResponse  A getDownloadLogResponse message contains an element of getDownloadLog.
getDownloadPackageInfoRequest  A getDownloadPackageInfoRequest message contains an element of getDownloadPackageByDownloadPackageId.
getDownloadPackageNameRequest  A getDownloadPackageNameRequest message contains an element of getDownloadPackageNameByActivationId.
getDownloadPackageNameResponse  A getDownloadPackageNameResponse message contains an element of getDownloadPackageNameByActivationId.
getDownloadPackageNoticeDetailsRequest  A getDownloadPackageNoticeDetailsRequest message contains an element of getDownloadPackageNoticeDetails.
getDownloadPackageNoticeDetailsResponse  A getDownloadPackageNoticeDetailsResponse message contains an element of getDownloadPackageNoticeDetails.
getDownloadPackageNotificationsRequest  A getDownloadPackageNotificationsRequest message contains an element of getDownloadPackageNotifications.
getDownloadPackageNotificationsResponse  A getDownloadPackageNotificationsResponse message contains an element of getDownloadPackageNotifications.
getDownloadPackagesByActivationIdsRequest  A getDownloadPackagesByActivationIdsRequest message contains an element of getDownloadPackagesByActivationIds.
getDownloadPackagesByActivationIdsResponse  A getDownloadPackagesByActivationIdsResponse message contains an element of getDownloadPackagesByActivationIds.
getDownloadPackagesRequest  A getDownloadPackagesRequest message contains an element of getDownloadPackages.
getDownloadPackagesResponse  A getDownloadPackagesResponse message contains an element of getDownloadPackageByDownloadPackageId and getDownloadPackages.
getEntitledOrganizationsRequest  A getEntitledOrganizationsRequest message contains an element of getEntitledOrganizations.
getEntitledOrganizationsResponse  A getEntitledOrganizationsResponse message contains an element of getEntitledOrganizations.
getEULARequest  A getEULARequest message contains an element of getEULA.
getEULAResponse  A getEULAResponse message contains an element of getEULA.
getFileDownloadsRequest  A getFileDownloadsRequest message contains an element of getFileDownloads.
getFileDownloadsResponse  A getFileDownloadsResponse message contains an element of getFileDownloads.
getFilesByDownloadPackagesRequest  A getFilesByDownloadPackagesRequest message contains an element of getFilesByDownloadPackages.
getFilesByDownloadPackagesResponse  A getFilesByDownloadPackagesResponse message contains an element of getFilesByDownloadPackages.
getImagesAndChartsRequest  A getImagesAndChartsRequest message contains an element of getImageAndCharts.
getImagesAndChartsResponse  A getImagesAndChartsResponse message contains an element of getImageAndCharts.
getManufacturerProductLineRequest  A getManufacturerProductLineRequest message contains an element of getManufacturerProductLine.
getManufacturerProductLineResponse  A getManufacturerProductLineResponse message contains an element of getManufacturerProductLine.
getNotDownloadedFilesRequest  A getNotDownloadedFilesRequest message contains an element of getNotDownloadedFiles.
getNotDownloadedFilesResponse  A getNotDownloadedFilesResponse message contains an element of getNotDownloadedFiles.
getRecentDownloadPackagesRequest  A getRecentDownloadPackagesRequest message contains an element of getRecentDownloadPackages.
getRecentDownloadPackagesResponse  A getRecentDownloadPackagesResponse message contains an element of getRecentDownloadPackages.
getRecentNotificationsRequest  A getRecentNotificationsRequest message contains an element of getRecentNotifications.
getRecentNotificationsResponse  A getRecentNotificationsResponse message contains an element of getRecentNotifications.
getRecentUploadedFilesRequest  A getRecentUploadedFilesRequest message contains an element of getRecentUploadedFiles.
getRecentUploadedFilesResponse  A getRecentUploadedFilesResponse message contains an element of getRecentUploadedFiles.
GroupId [type DownloadableFilesGroup]  Group ID.
HasCompressedContent [type DownloadableFile]  An array of flags indicating whether the files are compressed or not.
HasDownloadablePackages [element checkDownloadPackagesResponse]  An array of flags indicating whether corresponding activation IDs have downloadable packages or not. The array corresponds in size and order to the activation ids array, so each flag indicates whether the activation ID in the same position has Download Packages or not.
HasDownloadsRemaining [type DownloadableFile]  An array of flags indicating whether corresponding activation IDs have downloadable packages or not.
helmCommand [type ChartVersion]  The command used to pull the Helm chart.
home [type ChartVersion]  Home.
HTMLContent [type NotificationEmail]  HTML content.
icon [type Artifact]  Icon.
Id [type DownloadPackageReference]  Package ID.
Id [type UnknownIdError]  ID.
IncidentId [type UnexpectedError]  Incident ID.
includeCriticalUdf [element getRecentUploadedFilesRequest]  Include critical Custom Attributes.
IncludeDownloadedFiles [element getDownloadableFilesRequest] 

Flag indicating whether all files or only not downloaded files must be included in response.

Defaults to "true".

When the request is made on behalf of a user, it only includes files this user is entitled to. When the request is made per activation id, it includes files that a particular line item is entitled to.

IncludeDownloadedFiles [element getFilesByDownloadPackagesRequest]  Flag to include downloaded files.
IncludeExternalFiles [element getDownloadableFilesRequest]  Flag indicating whether the external files are downloadable or not.
IncludeExternalFiles [element getFilesByDownloadPackagesRequest]  Flag indicating whether the external files are downloadable or not.
includePkgVersions [element getRecentUploadedFilesRequest] 

Include Download Package versions.

Indicates that file's Download Package version need to be returned. defaults to false.

IncludeRelatedProducts [element getDownloadPackageNotificationsRequest]  Flag indicating whether to include packages sharing the same product line in the response.
installCommand [type HelmCommand]  Install command.
InvalidSearchQueryError  An InvalidSearchQueryError is thrown when an Query text is invalid.
ipAddress [element getAllFilesForPackageRequest]  IP Address of the requesting party. In case of a UI client, this is hopefully the UI browser's IP address.
ipAddress [element getDownloadableFilesRequest]  IP Address of the requesting party. In case of a UI client, this is hopefully the UI browser's IP address.
ipAddress [element getFilesByDownloadPackagesRequest]  IP Address of the requesting party. In case of a UI client, this is hopefully the UI browser's IP address.
IPAddress [type FileDownloadLog]  IP address of the downloader.
isCountQuery [element getDownloadPackagesByActivationIdsRequest]  Get the total count for a particular criterion.
isCountQuery [element getFilesByDownloadPackagesRequest]  Get the total count for a particular criterion.
isCurrentVersion [type DownloadPackage]  Flag indicating whether the version is current.
isExpired [type DownloadPackage]  A flag indication whether the Download Package is expired.
IsFileSynced [type DownloadableFile]  An array of flags indicating whether the files are synchronized with Akamai. 'Synchronized' means that the files have been copied to Akamai primary NetStorage.
isRestricted [type DownloadPackage]  A flag indication whether the Download Package is restricted or not.
keywords [type ChartVersion]  Keyword.
LastName [type Member]  Last name of the member.
LocaleLanguage [element getDownloadableFilesRequest]  Language of the file description.
LocaleLanguage [element getDownloadedFilesLogRequest]  Locale language of the file description.
LocaleLanguage [element getDownloadPackageNoticeDetailsRequest]  Locale language of the email content
LocaleLanguage [element getDownloadPackageNotificationsRequest]  Locale language of the email subject.
LocaleLanguage [element getDownloadPackagesRequest]  Locale language of the Download Packages names and descriptions.
LocaleLanguage [element getFilesByDownloadPackagesRequest]  Locale language of the file names and descriptions.
LocaleLanguage [element getManufacturerProductLineRequest]  Locale language of the product line names and descriptions.
LocaleLanguage [element getRecentDownloadPackagesRequest]  Locale language of the Download Package names and descriptions.
LocaleLanguage [element getRecentNotificationsRequest]  Locale language of the notification and descriptions.
LocaleLanguage [element getRecentUploadedFilesRequest]  Locale language of the file description.
LocaleLanguage [element searchDownloadableFilesRequest]  Locale Language of the file description.
LocaleLanguage [element searchDownloadPackagesRequest]  Locale Language of the Download Package description.
loginCommand [type Tag]  Login command.
Maintainers [type ChartVersion]  Maintainers of the chart version
ManufacturerId [type DownloadPackage]  Manufacturer ID of the Download Package.
ManufacturerId [type Manufacturer]  Manufacturer ID of the manufacturer.
ManufacturerName [type Manufacturer]  Manufacturer name.
Manufacturers [type Manufacturers]  An array of manufacturers, each including its respective product lines.
MassDownloadURL [type DownloadableFile]  URL for mass download.
MD5CheckSum [type DownloadableFile]  File's md5 checksum.
MediaAvailable [element getDownloadableFilesResponse]  Media availablility of the downloadable files.
MediaAvailable [element getFilesByDownloadPackagesResponse]  Media availablility of the downloadable files.
Member [type FileDownloadLog]  Member info.
Member [type RequestByUser]  User ID (email).
message [type RegistryServiceError]  Message.
Message [type RequestValidationError]  Message.
name [type Chart]  Chart name.
name [type ChartVersion]  Chart name.
name [type Maintainer]  Maintainer name.
name [type Repository]  Repository name.
name [type Tag]  Tag name.
NetStorageLocation [element getAllFilesForPackageRequest]  Net storage location.
NetStorageLocation [element getDownloadableFilesRequest]  Net storage location.
NetStorageLocation [element getFilesByDownloadPackagesRequest]  Net storage location.
NonDownloadableReason [type DownloadableFile]  If file is not downloadable, the reason.
NotificationEmail [element getDownloadPackageNoticeDetailsResponse]  Notification Email.
NotificationEmail [element getDownloadPackageNotificationsResponse]  Notification Email.
NotificationEmail [element getRecentNotificationsResponse]  Notification Email.
OrderBy [element getDownloadableFilesRequest]  Sort order of files in the response.
OrderBy [element getDownloadableFilesResponse]  Sort order of files in the response.
OrderBy [element getDownloadPackagesRequest]  Sort order of files in the response.
OrderBy [element getFilesByDownloadPackagesResponse]  Sort order of files in the response.
OrderBy [element getRecentNotificationsRequest]  Result sorting order. When not provided, SENTDATE is used.
OrderBy [element searchDownloadableFilesRequest]  Results sorting order. When value is not provided, results are ordered by relevance to the search string.
OrderBy [element searchDownloadPackagesRequest]  Results sorting order. When value is not provided, results are ordered by relevance to the search string.
OrderCDDownloadCount [type DownloadableFile]  The number of the file's media orders.
OrganizationCountryName [element getDownloadableFilesRequest]  Country name of an organization.
OrganizationCountryName [element getFilesByDownloadPackagesRequest]  Country name of an organization.
OrganizationId [element acceptComplianceAgreementRequest]  Organization ID.
OrganizationId [element acceptEULARequest]  Organization ID.
OrganizationId [element getComplianceAgreementRequest]  lOrganization ID.
OrganizationId [element getDownloadableFilesRequest]  Organization ID.
OrganizationId [element getDownloadedFilesLogRequest]  Organization ID.
OrganizationId [element getDownloadLogRequest]  Organization ID.
OrganizationId [element getDownloadPackageInfoRequest]  Organization ID.
OrganizationId [element getDownloadPackageNoticeDetailsRequest]  Organization ID.
OrganizationId [element getDownloadPackageNotificationsRequest]  Organization ID.
OrganizationId [element getDownloadPackagesByActivationIdsRequest]  Organization ID.
OrganizationId [element getDownloadPackagesRequest]  An array of one or more organization IDs.
OrganizationId [element getEULARequest]  Organization ID.
OrganizationId [element getFileDownloadsRequest]  Organization ID.
OrganizationId [element getFilesByDownloadPackagesRequest]  Organization ID.
OrganizationId [element getManufacturerProductLineRequest]  An array of organization IDs. If the array of organizations is not provided, all organizations the user is a member of are used
OrganizationId [element getNotDownloadedFilesRequest]  Organization ID.
OrganizationId [element getRecentDownloadPackagesRequest]  Organization ID.
OrganizationId [element getRecentNotificationsRequest]  Organization ID.
OrganizationId [element getRecentUploadedFilesRequest]  Organization ID.
OrganizationId [type Member]  Organization ID.
OrganizationId [type ProductLine]  Optional array of IDs of organizations entitled to this product line.
OrganizationId [type SearchQuery]  Organization ID.
OrganizationReference [element getEntitledOrganizationsRequest]  Organization Reference.
OrganizationReference [element getEntitledOrganizationsResponse]  Organization Reference.
OrganizationRegionName [element getDownloadableFilesRequest]  Region name of an organization.
OrganizationRegionName [element getFilesByDownloadPackagesRequest]  Region name of an organization.
OrgId [type OrganizationReference]  Organization ID. If organization ID is not provided, all entitled organizations are returned.
OrgName [type OrganizationReference]  Organization name.
owner [element getImagesAndChartsResponse]  Owner.
PackageVersion [type UploadedFile]  Package version. PackageVersion is only set if "includePkgVersions" flag was "true" in the request.
page [type RepositoryRequestParam]  Page.
PageNumber [element getDownloadPackagesByActivationIdsRequest]  Pagination attributes.
PageNumber [element getFilesByDownloadPackagesRequest]  Pagination attributes.
pageSize [type RepositoryRequestParam]  Page size.
PartnerCode [type DownloadPackage]  Tenant code.
ProductChart [element getManufacturerProductLineResponse]  An array of manufacturers, each including its respective product lines.
ProductChart [element getNotDownloadedFilesResponse]  Product chart.
productLine [element getImagesAndChartsResponse]  Product line.
ProductLineDescr [type ProductLine]  Product line description, language dependent (defaults to English if requested language is not present).
ProductLineId [type DownloadPackage]  Product line ID.
ProductLineId [type ProductLine]  Product line ID.
ProductLineName [type ProductLine]  Product line name.
ProductLineReference [element getDownloadPackagesRequest] 

Product line reference.

When Member property is supplied, either product line id or activation id must be supplied, but not both.

ProductLineReference [type DownloadableFile]  Product line ID.
ProductLines [type Manufacturer]  An array of product lines (see the product line description below).
ProductLines [type ProductLines]  An array of product lines (see the product line description below).
pullCommand [type HelmCommand]  Pull command.
pullCommand [type Tag]  Pull command.
pullCount [type Repository]  Pull count.
pullTime [type Artifact]  Pull time.
pushCommand [type Tag]  Push command.
pushDirectoryCommand [type HelmCommand]  Push directory command.
pushTgzCommand [type HelmCommand]  Push Tags Command.
pushTime [type Artifact]  Push time of the artifact.
pushWithProvenanceCommand [type HelmCommand]  Push with provenance command.
q [type ArtifactRequestParam]  Queue.
q [type RepositoryRequestParam]  Queue.
Query [element searchDownloadableFilesRequest]  See SearchQuery.
Query [element searchDownloadPackagesRequest]  See SearchQuery.
Query [type SearchQuery]  Search query.
RegistryServiceError  Registry Service Error.
releaseGroup [element getImagesAndChartsResponse]  Release group of the images and charts.
Repositories [element getImagesAndChartsResponse]  Repositories  of the images and charts.
repositoryAddCommand [type HelmCommand]  Repository add command.
RepositoryRequestParam [element getImagesAndChartsRequest]  Repository request param.
RequestValidationError  Request validation error.
restrictedDownloadPackage [element getImagesAndChartsResponse]  Restricting access to a Download Package.
RestrictedPackageDistributionError  Restricted package distribution error.
ResultSetSize [element getFileDownloadsRequest] 

Number of results in the response (for pagination).

ResultSetSize defaults to 1.

ResultSetSize [element getRecentNotificationsRequest] 

Number of results in the response (for pagination).

ResultSetSize defaults to 1.

ResultSetSize [type SearchQuery] 

Number of results in the response (for pagination).

ResultSetSize defaults to 1.

score [type Chart]  Chart score.
SearchBy [type DownloadPackageQueryParameters] 

Search the Download Package by,

  • searchKey - The possible search keys are DOWNLOADPACKAGE_ID and DOWNLOADPACKAGE_NAME.

    Note: The Download Package can be searched using these search keys with Availability as Current.

  • searchValue

SearchBy [type FilesQueryParameters] 

Search the files by,

  • searchKey - The possible search keys are FILE_DESC and FILE_NAME.
    Note: The files can be searched using these search keys with Availability as Current.

  • searchValue

  • Availability - It defaults to Current

SearchDays [element getRecentDownloadPackagesRequest]  Search days. The minimum value is 30 days and maximum value is 180 days. Default of 30 days is used if not provided. If SearchDays is less than 0 RequestValidationError is thrown.
SearchDays [element getRecentNotificationsRequest]  Search days. The minimum value is 30 days and maximum value is 180 days. Default of 30 days is used if not provided. If SearchDays is less than 0 RequestValidationError is thrown.
SearchDays [element getRecentUploadedFilesRequest]  Search days. The minimum value is 30 days and maximum value is 180 days. Default of 30 days is used if not provided. If SearchDays is less than 0 RequestValidationError is thrown.
searchDownloadableFilesRequest  A searchDownloadableFilesRequest message contains an element of searchDownloadableFiles.
searchDownloadableFilesResponse  A searchDownloadableFilesResponse message contains an element of searchDownloadableFiles.
searchDownloadPackagesRequest  A searchDownloadPackagesRequest message contains an element of searchDownloadPackages.
searchDownloadPackagesResponse  A searchDownloadPackagesResponse message contains an element of searchDownloadPackages.
searchKey [type FilesSearchQueryType] 

Search downloads with the following two search keys with availability as current:

  • FILE_DESC

  • FILE_NAME

searchKey [type SimpleSearchQueryType] 

The search keys to search the Download Pakage are DOWNLOADPACKAGE_ID and DOWNLOADPACKAGE_NAME.

Note: The Download Package can be searched using these search keys with Availability as Current.

searchValue [type FilesSearchQueryType]  Pass values in the format of %valueTosearchFor%, %valueTosearchFor, valueTosearchFor%.
searchValue [type SimpleSearchQueryType]  Pass values in the format of %valueTosearchFor%, %valueTosearchFor, valueTosearchFor%
SendDateTime [type NotificationEmail]  Send date and time of the notification email.
SHA256CheckSum [type DownloadableFile]  File's sha256 checksum.
size [type Artifact]  Size of the artifact.
SortBy [element getDownloadPackagesByActivationIdsRequest] 

Sort the Download Package by,

  • SortKey - The possible sort keys are DOWNLOADPACKAGE_ID and DOWNLOADPACKAGE_NAME.

  • Ascending

SortBy [element getFilesByDownloadPackagesRequest] 

Sort the downloadby,

  • SortKey - The possible sort keys are FILE_DESC and FILE_NAME.

  • Ascending

SortKey [type DownloadPackageSortBy]  The sort keys to sort the Download Package are DOWNLOADPACKAGE_ID and DOWNLOADPACKAGE_NAME.
SortKey [type FilesSortBy]  The sort keys to sort the downloads are FILE_DESC and FILE_NAME.
StartDateTime [type FileDownloadLog]  The start date and time of file download log.
StartOffset [element getFileDownloadsRequest] 

Index of the first result starting with 0 (for pagination).

StartOffset defaults to 0.

StartOffset [element getRecentNotificationsRequest] 

Index of first result starting with 0 (for pagination).

StartOffset defaults to 0.

StartOffset [type SearchQuery] 

Index of first result starting with 0 (for pagination).

StartOffset defaults to 0.

status [type RegistryServiceError]  Status of registry service error.
StatusCode [type DownloadableFile] 

Status codes of the downloadable file are:

  • LOADED - the File was loaded to the repository and is available for customers to download (provided the File is properly associated to Product s and Catalog Items that the customer is entitled to).

  • NOT_LOADED - the File has NOT been loaded, or the Upload process has not yet completed.

  • ARCHIVE - the File is archived by Flexera and is available for download on request (File candidates for archiving are based on the age of File and whether there are any customers entitled to the File).

  • DELETED - the File is deleted from the repository and is not available for customers to download.

StatusCode [type DownloadPackage] 

Status codes of the Download Package file are:

  • LOADED - the File was loaded to the repository and is available for customers to download (provided the File is properly associated to Product s and Catalog Items that the customer is entitled to).

  • NOT_LOADED - the File has NOT been loaded, or the Upload process has not yet completed.

  • ARCHIVE - the File is archived by Flexera and is available for download on request (File candidates for archiving are based on the age of File and whether there are any customers entitled to the File).

  • DELETED - the File is deleted from the repository and is not available for customers to download.

Subject [type NotificationEmail]  Subject of the notification email.
sysDownloadPackageId [element getImagesAndChartsResponse]  Download Package ID of the system.
SystemEmailId [type EmailReference]  System email ID.
SystemFileId [type DownloadableFileReference]  System file ID.
SystemId [type DownloadPackageReference]  System ID.
tagCommand [type Tag]  Tag command.
TagDescription [type UserDefinedField]  Custom attribute description.
TagName [type UserDefinedField]  Custom attribute name.
Tags [type Artifact]  Tag.
TextContent [type NotificationEmail]  Text content.
timestamp [type RegistryServiceError]  Timestamp representing the date and time that the registry service error was thrown.
Title [type Member]  Title of the member.
TotalCount [element getDownloadPackagesByActivationIdsResponse]  Total count of the Download Package.
TotalCount [element getFilesByDownloadPackagesResponse]  Total count of the downloads.
TotalMatches [element searchDownloadableFilesResponse]  Total matches count. Number of all matches found in the index. Might be greater than the number of results returned.
TotalMatches [element searchDownloadPackagesResponse]  Total matches count. Number of all matches found in the index. Might be greater than the number of results returned.
TotalResults [element getFileDownloadsResponse]  Total number of downloads (for paginated responses).
type [type Artifact]  Type.
UdfFilters [element getAllFilesForPackageRequest]  Custom attribute filters to apply to returned files.
UdfFilters [element getDownloadableFilesRequest] 

Custom attribute filters to apply to returned files:

  • Custom Attribute Name

  • Content - The values must contain "TagName" and "Value" in every "Content" element.

UnexpectedError  Unexpected error.
UnknownActivationIdError  Unknown Activation ID Error.
UnknownDownloadLogError  Log error for a unknown download.
UnknownDownloadPackageError  UnknownDownloadPackageError is thrown when the Download Package is not found in the database or restricted.
UnknownEmailError  A UnknownEmailError is thrown when the for the  Email id passed in the request is not found.
UnknownFileError  This operation requires input of System File ID; It is returned in the response of the preceding "getDownloadedFilesLog" call. If the file is not found in the database, UnknownFileError is thrown.
UnknownOrganizationError  For the Organization passed in the request, check that it matches the Member parameter. If it does not match, a UnknownOrganizationError is thrown.
UnknownPrincipalError  Unknown principal error.
UnknownProductLineError  A UnknownProductLineError is thrown when a product line is not found in the database.
updateTime [type Repository]  Update time.
UploadedFile [element getRecentUploadedFilesResponse]  Uploaded files within the specified number of days. The number of days is a configurable value. The minimum value is 30 days and maximum value is 180 days.
urls [type ChartVersion]  URLs.
UserDefinedFields [type DownloadableFile]  Custom attributes array.
Value [type UdfValue]  Custom value. The values must contain "TagName" and "Value" in every "Content" element.
version [element getImagesAndChartsResponse]  Package version.
version [type ChartVersion]  Chart version.
Version [type DownloadPackage]  Version of the Download Package.
VersionNumber [type DownloadPackageVersion]  The version number of a Download Package.
VersionType [element getDownloadPackageInfoRequest] 

Download package version type. The possible values are:

  • Current - default version type.

  • Archive

  • All 

VersionType [element getDownloadPackagesRequest] 

Download package version type. The possible values are:

  • Current - default version type.

  • Archive

  • All

withTag [type ArtifactRequestParam]  With tag.