Get all import requests
get
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- simpleSearchFinder: Finds the import request that matches the specified file name, description, import status, package title, or the release version. Finder Variables:
- value; string; The search parameter that can be the file name, description, import status, package title, or the release version.
- simpleSearchFinder: Finds the import request that matches the specified file name, description, import status, package title, or the release version. Finder Variables:
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorSolutionPackageAttachments
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The items in the collection.
Show Source
-
Array of:
object publicSectorSolutionPackageAttachments-item
Discriminator:
AttachmentType
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorSolutionPackageAttachments-item
Type:
object
Discriminator:
Show Source
AttachmentType
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency. -
AttachmentEntityName(optional):
string
The entity name that is used by the attachment framework.
-
AttachmentId(optional):
integer(int64)
The unique identifier of the attachment.
-
AttachmentType:
string
Maximum Length:
15
The file type of the attachment. -
CreatedBy(optional):
string
Title:
Uploaded By
Maximum Length:64
The name of the user who created the row. -
CreatedByName(optional):
string
Title:
Uploaded By
The name of the user who created the attachment. -
CreationDate(optional):
string(date-time)
Title:
Uploaded On
The date and time when the row was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description about the attachment. -
FileName(optional):
string
Title:
File Name
Maximum Length:255
The file name of the attachment. -
FileSize(optional):
integer(int64)
Title:
File Size
The file size of the attachment. -
FileType(optional):
string
Maximum Length:
100
The column that is used to indicate file type. -
ImportId(optional):
integer(int64)
Title:
Import ID
The unique identifier of the import process. -
ImportStatus(optional):
string
Title:
Import Status
Maximum Length:50
The status of the import process. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
PkgTitle(optional):
string
Title:
Solution Package Title
Maximum Length:100
The title of the package that is being imported. -
ReleaseVersion(optional):
string
Title:
Release Version
Maximum Length:80
The release version of the package. -
SlAttachmentAccessor(optional):
array Attachments
Title:
Attachments
The solution package import resource is used to enable attachments for the Solution Package Import process. Users can view the details of the imported files such as their status and the import history. -
UpdatedByName(optional):
string
Title:
Last Updated By
The name of the user who last updated the attachment. -
Version(optional):
integer(int32)
The file version.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The solution package import resource is used to enable attachments for the Solution Package Import process. Users can view the details of the imported files such as their status and the import history.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorSolutionPackageAttachments-SlAttachmentAccessor-item
Type:
Show Source
object
-
AsyncTrackerId(optional):
string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId(optional):
integer(int64)
Title:
Attached Document Id
The attached document ID that is used by the Attachments framework. -
AttachmentsRevision(optional):
array Attachment Revisions
Title:
Attachment Revisions
The attachments resource is used to perform the file attachment functionality. -
CategoryName(optional):
string
Title:
Category
Maximum Length:30
The category name of the attachment that is used by the Attachments framework. - ContentRepositoryFileShared(optional): boolean
-
CreatedBy(optional):
string
Title:
Created By
Maximum Length:255
The name of the user who created the row. -
CreatedByUserName(optional):
string
Title:
Created By User Name
The name of the user who created the attachment that is used by the Attachment framework. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
DatatypeCode(optional):
string
Title:
Type
Maximum Length:30
The data type code that is used by the Attachments framework.. -
Description(optional):
string
Title:
Description
Maximum Length:255
The description of the attachment that is used by the Attachment framework. -
DmDocumentId(optional):
string
Maximum Length:
255
The identifier of the document that is used by the Attachments framework. -
DmFolderPath(optional):
string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment that is used by the Attachments framework. -
DmVersionNumber(optional):
string
Maximum Length:
255
The version number that is used by the Attachments framework. -
ErrorStatusCode(optional):
string
Title:
Error Status Code
The error status code of the attachment that is used by the Attachment framework. -
ErrorStatusMessage(optional):
string
Title:
Error Status Message
The error status message of the attachment that is used by the Attachment framework. -
ExpirationDate(optional):
string(date-time)
Title:
Expiration Date
The expiration date of the attachment that is used by the Attachment framework. -
FileContents(optional):
string(binary)
Title:
File Contents
The contents of the attachment file that is used by the Attachment framework. -
FileName(optional):
string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl(optional):
string
Title:
File Url
The URL of the attachment file that is used by the Attachments framework. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Update Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:255
The name of the user who last updated the row. -
LastUpdatedByUserName(optional):
string
Title:
Last Updated By User
The name of the user who last updated the attachment that is used by the Attachment framework. -
links(optional):
array Items
Title:
Items
Link Relations -
Title(optional):
string
Title:
Title
The title of the attachment that is used by the Attachment framework. -
UploadedFileContentType(optional):
string
Title:
Uploaded File Content Type
The uploaded file content type of the attachment that is used by the Attachment framework. -
UploadedFileLength(optional):
integer(int64)
Title:
File Size
The uploaded length of the attachment file that is used by the Attachment framework. -
UploadedFileName(optional):
string
Title:
Uploaded File Name
The uploaded file name of the attachment that is used by the Attachment framework. -
UploadedText(optional):
string
Title:
Uploaded Text
The uploaded text from the attachment that is used by the Attachments framework. -
Uri(optional):
string
Title:
Uri
Maximum Length:4000
The URL of the attachment that is used by the Attachments framework. -
Url(optional):
string
Title:
Url
Maximum Length:4000
The URL of the attachment that is used by the Attachments framework. -
UserName(optional):
string
Title:
User Name
Maximum Length:255
The user name that is used by the Attachments framework.
Nested Schema : Attachment Revisions
Type:
array
Title:
Attachment Revisions
The attachments resource is used to perform the file attachment functionality.
Show Source
Nested Schema : publicSectorSolutionPackageAttachments-SlAttachmentAccessor-AttachmentsRevision-item
Type:
Show Source
object
-
AttachedDocumentId(optional):
integer(int64)
The attached document ID of the attachment that is used by the Attachment framework.
-
ContentId(optional):
string
Maximum Length:
80
The content ID of the attachment that is used by the Attachment framework. -
ErrorStatusCode(optional):
string
The error status code of the attachment that is used by the Attachment framework.
-
ErrorStatusMessage(optional):
string
The error status message of the attachment that is used by the Attachment framework.
-
FileUrl(optional):
string
The URL of the attachment file that is used by the Attachment framework.
-
Format(optional):
string
Maximum Length:
128
The format of the attachment that is used by the Attachment framework. -
InDate(optional):
string(date-time)
The entry date of the attachment that is used by the Attachment framework.
-
links(optional):
array Items
Title:
Items
Link Relations -
RevisionId(optional):
string
Maximum Length:
80
The revision ID of the attachment that is used by the Attachment framework. -
RevLabel(optional):
string
Maximum Length:
80
The revision label of the attachment that is used by the Attachment framework. -
UserRevisionId(optional):
integer(int64)
The user revision ID of the attachment that is used by the Attachment framework.