Get an agency offering
get
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyOptions/{AgencyOptionsUniqID}
Request
Path Parameters
-
AgencyId: integer
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.
-
AgencyOptionsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and OfferingId ---for the Agency Options resource and used to uniquely identify an instance of Agency Options. The client should not generate the hash key value. Instead, the client should query on the Agency Options collection resource with a filter on the primary key values in order to navigate to a specific instance of Agency Options.
For example: AgencyOptions?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 : publicSectorAgencies-AgencyOptions-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
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. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the agency option. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time the agency option was created. -
DestURL(optional):
string
Maximum Length:
254
A transient value calculated at runtime that fetches the jet path of the offering options page if it exists. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates whether the offering is enabled for the agency. A value of Y means the offering is enabled. Default value is Y. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The last date and time the agency option was updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the agency option. -
links(optional):
array Items
Title:
Items
Link Relations -
OfferingId(optional):
string
Title:
Offering
Maximum Length:80
The unique identifier of the product offering. -
OfferingName(optional):
string
Title:
Offering
Maximum Length:150
The name of the product offering. -
OptOffering(optional):
string
A transient value calculated at runtime to identify whether an offering is enabled or disabled in Functional Setup Manager.
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.