Jump to

• Request
• Response

Update an agency feature

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAgencyFeatures/{publicSectorAgencyFeaturesUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorAgencyFeaturesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId and FeatureCode ---for the Agency Features resource and used to uniquely identify an instance of Agency Features. The client should not generate the hash key value. Instead, the client should query on the Agency Features collection resource with a filter on the primary key values in order to navigate to a specific instance of Agency Features.
  
  For example: publicSectorAgencyFeatures?q=AgencyId=<value1>;FeatureCode=<value2>

Body ()

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

Root Schema : publicSectorAgencyFeatures-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier for an agency.
• EnabledFlag(optional): string
  Maximum Length: 1

  Identifies whether the feature is enabled for the agency.
• FeatureCode(optional): string
  Maximum Length: 160

  The unique identifier for a feature.
• links(optional): array Items
  Title: Items

  Link Relations
• OfferingId(optional): string
  Maximum Length: 160

  The code of the FSM offering, functional area, or feature.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for an agency."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Identifies whether the feature is enabled for the agency."
        },
        "FeatureCode":{
            "maxLength":160,
            "type":"string",
            "description":"The unique identifier for a feature."
        },
        "OfferingId":{
            "maxLength":160,
            "type":"string",
            "description":"The code of the FSM offering, functional area, or feature."
        },
        "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 : publicSectorAgencyFeatures-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier for an agency.
• EnabledFlag(optional): string
  Maximum Length: 1

  Identifies whether the feature is enabled for the agency.
• FeatureCode(optional): string
  Maximum Length: 160

  The unique identifier for a feature.
• links(optional): array Items
  Title: Items

  Link Relations
• OfferingId(optional): string
  Maximum Length: 160

  The code of the FSM offering, functional area, or feature.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for an agency."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Identifies whether the feature is enabled for the agency."
        },
        "FeatureCode":{
            "maxLength":160,
            "type":"string",
            "description":"The unique identifier for a feature."
        },
        "OfferingId":{
            "maxLength":160,
            "type":"string",
            "description":"The code of the FSM offering, functional area, or feature."
        },
        "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