Get a permit agency options definition
get
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions/{publicSectorPermitAgencyOptionsUniqID}
Request
Path Parameters
-
publicSectorPermitAgencyOptionsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and OfferingId ---for the Permit Agency Options resource and used to uniquely identify an instance of Permit Agency Options. The client should not generate the hash key value. Instead, the client should query on the Permit Agency Options collection resource with a filter on the primary key values in order to navigate to a specific instance of Permit Agency Options.
For example: publicSectorPermitAgencyOptions?q=AgencyId=<value1>;OfferingId=<value2>
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPermitAgencyOptions-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The identifier for the agency associated with the permit agency options.
-
ContentUrl(optional):
string
Maximum Length:
250
The content URL used to link to an agency page outside of the permits service. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the permit agency options. -
CreationDate(optional):
string(date-time)
The date when the permit agency options were created.
-
LastUpdateDate(optional):
string(date-time)
The date when the permit agency options were last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the permit agency options. -
links(optional):
array Items
Title:
Items
Link Relations -
LongDescription(optional):
string
The long version of the landing page message title in a sentence format.
-
OfferingId(optional):
string
Maximum Length:
50
The unique identifier for the functional product Oracle Public Sector Permits in the Oracle Public Sector Compliance and Regulation pillar that is used by the agency. -
OpaPolicyId(optional):
string
Maximum Length:
150
The identifier for the Oracle Policy Automation policy definition used for the permit guide. -
ShortDescription(optional):
string
Maximum Length:
300
The short text version of the landing page message in a title format. -
TextLabel(optional):
string
Maximum Length:
100
The information in rich text that appears in a dialog box when the user clicks the read more button on a public landing page. If a URL to access an agency page is defined, this message is not needed.
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.