Get Custom CAL Package Files
post
/content/sim/v2/setup/cal/getCustomPackageFileList
Gets Custom CAL Package Files for the specified custom CAL package.
Request
Supported Media Types
- multipart/form-data
- application/json
The input body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
packageId, fileId, filePath, fileSize, platformType -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
fileId:asc -
packageId(required):
integer
Unique reference of the Custom CAL Package.Example:
101 -
searchCriteria:
string
If specified, returns records that match the criteria. Allowed fields include packageId, fileId, filePath, fileSize, and platformType.Example:
where equals(fileId, 17016)
Response
Supported Media Types
- application/json
200 Response
A collection of Custom CAL Package Files.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
10 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Custom CAL Package File objects.
-
limit:
integer
Server page size.Example:
10 -
offset:
integer
Starting resource record index.Example:
0 -
totalResults:
integer
Total number of rows.Example:
100
Nested Schema : items
Type:
arrayArray of Custom CAL Package File objects.
Show Source
-
Array of:
object CustomCALPackageFile
Model for a Custom CAL Package File object.
Nested Schema : CustomCALPackageFile
Type:
objectModel for a Custom CAL Package File object.
Show Source
-
fileId:
integer
Unique reference of the Custom CAL Package File.Example:
17016 -
filePath:
string
Name or path of the Custom CAL Package File.Example:
setup.dat -
fileSize:
integer
Size of the Custom CAL Package File in bytes.Example:
458 -
packageId:
integer
Unique reference of the Custom CAL Package.Example:
101 -
platformType:
integer
The type of platform that receives the Custom CAL Package File. Valid values are 0, 1, 50, 69, and 80.Example:
50