1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Projects
  4. Project Attachments

Get all project attachment

get

/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments

Request

Query Parameters
  • 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).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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
  • 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:

    • PrimaryKey: Finds a project attachment that matches the primary key criteria.
      Finder Variables:
      • AttachmentId; integer.
      • AttachmentKey; integer; The unique identifier for the project attachment.
    • simpleSearchFinder: Finds a project attachment that matches the specified keyword.
      Finder Variables:
      • value; string; The keyword used to find the attachment row.
  • 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.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. 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
  • 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

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AgencyId; integer; The unique identifier of the public sector agency.
    • AttachmentEntityName; string; The unique identifier to indicate project attachments(PSC_DOC_PRO) used by the attachment component.
    • AttachmentId; integer; The unique identifier of the attachment from the common attachment table.
    • AttachmentKey; integer; The unique identifier for the project attachment row.
    • AttachmentType; string; The attachment type to identify project attachments. The values is PRO.
    • ConfidentialFlag; boolean; Indicates whether the attachment is a confidential document. The default value is N for no.
    • CreatedByName; string; The name of the user who created the attachment.
    • CreationDate; string; The date and time when the attachment was created.
    • Description; string; The description for the file attached.
    • DocumentCategory; string; The unique identifier for the document category.
    • DocumentGroupId; string; The unique identifier for the document group.
    • DocumentSubcategory; string; The unique identifier for the document subcategory.
    • FileName; string; The name of the file attached.
    • FileSize; integer; The size of the file attached.
    • FileType; string; The type of the file attached whether text/plain, image/jpeg and so on.
    • LastUpdateDate; string; The date and time when the attachment was last updated.
    • PreviewHeight; number; This column indicates the height of a stored thumbnail.
    • PreviewWidth; number; This column indicates the width of a stored thumbnail.
    • ProjectAgencyId; integer; The unique identifier of the public sector agency.
    • ProjectAttachmentId; integer; The unique identifier of the attachment from the common attachment table.
    • ProjectCode; string; The unique identifier of the project.
    • RequiredFlag; boolean; Indicates whether the attachment is a required document. The default value is N for no.
    • UpdatedByName; string; The name of the user who last updated the attachment.
    • Version; integer; The version of the attachment.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : publicSectorProjectAttachments
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorProjectAttachments-item-response
Type: object
Show Source
Nested Schema : Project Attachment Accessors
Type: array
Title: Project Attachment Accessors
The project attachment accessor resource is used for displaying file-related information such as file name and file URL.
Show Source
Nested Schema : publicSectorProjectAttachments-ProjectAttachmentAccessor-item-response
Type: object
Show Source
Nested Schema : Project Attachment Revisions
Type: array
Title: Project Attachment Revisions
The project attachment revisions resource is used for displaying the historical information for an attachment.
Show Source
Nested Schema : publicSectorProjectAttachments-ProjectAttachmentAccessor-AttachmentsRevision-item-response
Type: object
Show Source
Back to Top