Create an agency offering
post
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyOptions
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
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.
The following table describes the body parameters in the request 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.
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.