Jump to

• Request
• Response

Update an agency offering

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAgencyOptions/{publicSectorAgencyOptionsUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorAgencyOptionsUniqID: 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: publicSectorAgencyOptions?q=AgencyId=<value1>;OfferingId=<value2>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorAgencyOptions-item

Type: object

Show Source

• 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 offering.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time the agency offering 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 user who last updated the agency offering.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The last date and time the agency offering was updated.
• links(optional): array Items
  Title: Items

  Link Relations
• OfferingId(optional): 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(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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"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.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency offering.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the agency offering was created.",
            "title":"Creation Date"
        },
        "DestURL":{
            "maxLength":254,
            "type":"string",
            "description":"A transient value calculated at runtime that fetches the jet path of the offering options page if it exists."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the offering is enabled for the agency.  A value of Y means the offering is enabled.  Default value is Y.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The user who last updated the agency offering.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last date and time the agency offering was updated.",
            "title":"Last Updated By"
        },
        "OfferingId":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "title":"Offering"
        },
        "OfferingName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the product offering.",
            "title":"Offering"
        },
        "OptOffering":{
            "type":"string",
            "description":"A transient value calculated at runtime to identify whether an offering is enabled or disabled in Functional Setup Manager."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorAgencyOptions-item

Type: object

Show Source

• 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 offering.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time the agency offering 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 user who last updated the agency offering.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The last date and time the agency offering was updated.
• links(optional): array Items
  Title: Items

  Link Relations
• OfferingId(optional): 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(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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"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.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency offering.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the agency offering was created.",
            "title":"Creation Date"
        },
        "DestURL":{
            "maxLength":254,
            "type":"string",
            "description":"A transient value calculated at runtime that fetches the jet path of the offering options page if it exists."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the offering is enabled for the agency.  A value of Y means the offering is enabled.  Default value is Y.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The user who last updated the agency offering.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last date and time the agency offering was updated.",
            "title":"Last Updated By"
        },
        "OfferingId":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "title":"Offering"
        },
        "OfferingName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the product offering.",
            "title":"Offering"
        },
        "OptOffering":{
            "type":"string",
            "description":"A transient value calculated at runtime to identify whether an offering is enabled or disabled in Functional Setup Manager."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top