1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Code Enforcement
  4. All Case Attachments

Get all case attachments

get

/fscmRestApi/resources/11.13.18.05/publicSectorCaseAllAttachments

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 the attachment that matches the primary key criteria specified.
      Finder Variables:
      • AttachmentId; integer; The unique identifier of the attachment.
      • AttachmentKey; integer; The unique key for the attachment.
    • simpleSearchFinder: Finds an attachment using the specified keyword.
      Finder Variables:
      • value; string; The keyword used to find an attachment by description or file name.
  • 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:
    • AttachmentEntityMeaning; string; The description of the attachment entity such as case, case intake, case inspection, incident inspection, incident intake or appeal and hearing.
    • AttachmentEntityName; string; The entity name of the attachment.
    • AttachmentEntityType; string; The entity type of the attachment.
    • AttachmentId; integer; The identifier of the case attachment.
    • AttachmentKey; integer; The unique identifier of the case attachment.
    • AttachmentType; string; The type of attachment, such as for case, case inspection, incident inspection, or appeal and hearing.
    • CaseKey; integer; The unique identifier of the case.
    • ConfidentialFlag; string; 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 case attachment.
    • CreatedByUserType; string; The type of the user who created the case attachment such as agency user, anonymous user or public user.
    • CreatedByUserTypeMeaning; string; The description of the user type who created the case attachment.
    • CreationDate; string; The date and time when the attachment was created.
    • Description; string; The description of the case attachment.
    • DocCategory; string; The document category of the case attachment.
    • DocSubcategory; string; The document subcategory code of the case attachment.
    • FileContentUploadedFlag; string; Indicates whether the attachment file contents has been successfully uploaded. The default value is N for no. The core attachments API has been restructured for attachments insert functionality. See Document 3034288.1 in My Oracle Support.
    • FileName; string; The name of the attached file.
    • FileSize; integer; The size of the attached file.
    • FileType; string; The file format of the attachment, such as PDF or text.
    • LastUpdateDate; string; The date and time when the attachment was last updated.
    • ObjectVersionNumber; integer; The object version number for the attachment.
    • PreviewHeight; number; This column indicates the height of a stored thumbnail.
    • PreviewWidth; number; This column indicates the width of a stored thumbnail.
    • RequiredFlag; string; 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 case 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 : publicSectorCaseAllAttachments
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorCaseAllAttachments-item-response
Type: object
Show Source
Nested Schema : All Case Attachment Accessors
Type: array
Title: All Case Attachment Accessors
Used to display the attachment file-related information such as the file name and file URL.
Show Source
Nested Schema : publicSectorCaseAllAttachments-CaseAllAttachmentAccessor-item-response
Type: object
Show Source
Nested Schema : All Case Attachment Revisions
Type: array
Title: All Case Attachment Revisions
Used to display the historical information for a case attachment.
Show Source
Nested Schema : publicSectorCaseAllAttachments-CaseAllAttachmentAccessor-AttachmentsRevision-item-response
Type: object
Show Source
Back to Top