1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Designer
  4. Reference Entities

Get all reference entities

get

/fscmRestApi/resources/11.13.18.05/publicSectorReferenceEntities

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 reference entity using the primary key.
      Finder Variables:
      • RecordKey; integer.
      • RefEntityLocationKey; integer; The primary key value.
    • simpleSearchFinder: Finds a reference entity type using the specified keyword.
      Finder Variables:
      • value; string; The keyword value
  • 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:
    • Address1; string; The address in which a reference entity is located.
    • Address2; string; The address line 2 in which a reference entity is located.
    • AgencyId; integer; The agency ID of the reference entity.
    • Category; string; The category of a reference entity.
    • CategoryMeaning; string; The meaning of a category as defined for the lookup type.
    • City; string; The city in which a reference entity is located.
    • Classification; string; The classification of the reference entity.
    • ClosedDate; string; The closed date of a reference entity.
    • Country; string; The country in which a reference entity is located.
    • CreatedBy; string; The user who created the reference entity type.
    • CreatedByUserName; string; The user who last updated the reference entity type.
    • CreationDate; string; The date when the reference entity type was last updated.
    • CreationDateLocation; string; The creation date of a location child object.
    • CurrentTransFlag; string; Indicates the current transaction for a reference entity.
    • Description; string; The description of a reference entity.
    • DescriptionPlain; string; The description in plain text.
    • LastFeatureEditDate; string; The last update date of the feature of reference entity.
    • LastUpdateDate; string; The date when the reference entity type was created.
    • LastUpdateDateLocation; string; The last update date of the GIS feature of the reference entity of a location.
    • LastUpdatedBy; string; The user who last updated the reference entity type.
    • LastUpdatedByUserName; string; The user who last updated the reference entity type.
    • Latitude; number; The lattitude of a reference entity location.
    • LayoutVersion; string; The layout version of a reference entity.
    • Longitude; number; The longitude of a reference entity location.
    • MigratedDataFlag; string; The migrated flag of the reference entity, indicating whether the reference entity was migrated.
    • MobileFlag; string; The mobile flag of reference entity, indicating if it is application to mobile usage.
    • ParentRecordKey; integer; The parent ID of the reference entity.
    • PostalCode; string; The postal code in which a reference entity is located.
    • ProgramTypeId; string; The program type ID of reference entity.
    • ReName; string; The name of a reference entity.
    • ReType; string; The reference entity type for a reference entity.
    • ReTypeCode; string; The type code of a reference entity.
    • ReTypeId; string; The type ID of a reference entity.
    • RecordId; string; The record ID of the reference entity.
    • RecordKey; integer; The unique ID for reference entity.
    • RecordName; string; The record name for a reference entity.
    • RecordNumber; string; The record number for a reference entity.
    • RefEntityLocationId; string; The location ID of a reference entity.
    • RefEntityLocationKey; integer; The location of a reference entity.
    • RowType; string; The row type of a reference entity.
    • State; string; The state in which a reference entity is located.
    • Status; string; The status of the reference entity.
    • StatusMeaning; string; The meaning of a status as defined for the lookup type.
    • SubClassification; string; The sub classification of the reference entity.
    • Subcategory; string; The sub category of a reference entity.
    • SubcategoryMeaning; string; The meaning of a subcategory as defined for the lookup type.
    • SubmitDate; string; The submit date of a reference entity.
  • 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 : publicSectorReferenceEntities
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorReferenceEntities-item-response
Type: object
Show Source
Back to Top