1. REST API for Oracle Public Sector Cloud Release 13
  2. Tasks
  3. Agencies

Get all agencies

get

/fscmRestApi/resources/11.13.18.05/publicSectorAgencies

Request

Query Parameters
  • 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>
  • 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 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
  • 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 an agency with the agency name. Finder Variables:
      • value; string; The name of the agency.
    • PrimaryKey: Finds an agency with the specified primary key criteria. Finder Variables:
      • AgencyId; integer; The unique identifier of the agency.
  • 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.
  • 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 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
  • 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
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : publicSectorAgencies
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorAgencies-item
Type: object
Show Source
  • (AgencyAddress)
    Title: (AgencyAddress)
    The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.
  • Title: Agency ID
    The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1.
  • (AgencyLang)
    Title: (AgencyLang)
    The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.
  • Title: Name
    Maximum Length: 100
    The name of the agency. Value is mandatory and is defined by the user during a create action.
  • (AgencyOptions)
    Title: (AgencyOptions)
    The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.
  • Maximum Length: 1
    Indicates whether the agency defines its own reference data or shares a common set of data. The only accepted value is A (Agency) at this time. Value is mandatory and system-assigned.
  • Title: Country
    Maximum Length: 3
    The country in which the agency is located. Value is mandatory and is defined by the user during a create action. A list of accepted values is defined in PSC_COM_COUNTRY_B.
  • Title: Created By
    Maximum Length: 64
    The user who created the agency.
  • Title: Creation Date
    The date and time that the agency was created.
  • Title: Currency
    Maximum Length: 3
    The base currency in which the agency operates. Value is mandatory and is defined by the user during a create action. A list of accepted values is defined in PSC_COM_CURRENCY_B.
  • Title: Date Format
    Maximum Length: 30
    The format for displaying date for the agency. Value is mandatory and the default value is m/dd/yy, for example, 1/31/99.
  • Title: Description
    Maximum Length: 300
    The long description of the agency. Value is mandatory and is defined by the user during a create action.
  • Title: Create Subledger Accounting
    Maximum Length: 1
  • Title: Last Updated Date
    The last date and time that the agency was updated.
  • Title: Last Updated By
    Maximum Length: 64
    The user who last updated the agency.
  • Title: Financials Cloud Ledger
  • Maximum Length: 30
  • Items
  • Title: Number Format
    Maximum Length: 30
    The format for displaying number for the agency. Value is mandatory and the default value is #,##0.###, for example, -1,234.567.
  • Title: Parcel Owner Format
    Maximum Length: 3
    Indicates the preferred format for displaying parcel owner name. Accepted values are 1 (Use one field) and 2 (Use two fields) . The default value is 1.
  • Title: Time Format
    Maximum Length: 30
    The format for displaying time for the agency. Value is mandatory and the default value is h:mm a, for example, 1:30 PM.
  • Title: Time Zone
    Maximum Length: 64
    The time zone in which the agency is located. Value is mandatory and is defined by the user during a create action.
Nested Schema : (AgencyAddress)
Type: array
Title: (AgencyAddress)
The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.
Show Source
Nested Schema : (AgencyLang)
Type: array
Title: (AgencyLang)
The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.
Show Source
Nested Schema : (AgencyOptions)
Type: array
Title: (AgencyOptions)
The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.
Show Source
Nested Schema : publicSectorAgencies-AgencyAddress-item
Type: object
Show Source
Nested Schema : publicSectorAgencies-AgencyLang-item
Type: object
Show Source
Nested Schema : publicSectorAgencies-AgencyOptions-item
Type: object
Show Source
Back to Top