Create an agency offering
post
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyOptions
Request
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: 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. -
EnabledFlag: 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. -
OfferingId: string
Title:
Offering
Maximum Length:80
The unique identifier of a product offering that can be enabled by the agency. Acceptable values are those offerings enabled in Functional Setup Manager. Value is mandatory and is system-maintained.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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".
-
REST-Framework-Version(required):
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.
Root Schema : publicSectorAgencyOptions-item-response
Type:
Show Source
object
-
AgencyId: 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: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the agency offering. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time the agency offering was created. -
DestURL: string
Read Only:
true
Maximum Length:254
A transient value calculated at runtime that fetches the jet path of the offering options page if it exists. -
EnabledFlag: 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: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the agency offering. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The last date and time the agency offering was updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OfferingId: string
Title:
Offering
Maximum Length:80
The unique identifier of a product offering that can be enabled by the agency. Acceptable values are those offerings enabled in Functional Setup Manager. Value is mandatory and is system-maintained. -
OfferingName: string
Title:
Offering
Read Only:true
Maximum Length:150
The name of the product offering. -
OptOffering: string
Read Only:
true
A transient value calculated at runtime to identify whether an offering is enabled or disabled in Functional Setup Manager.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.