Jump to

• Request
• Response

Update a credential group detail

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupsKeys/{publicSectorCredentialGroupsKeysUniqID}

Request

Path Parameters

• publicSectorCredentialGroupsKeysUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, CredGroupId, EffectiveStartDate and EffectiveEndDate ---for the Credential Group Keys resource and used to uniquely identify an instance of Credential Group Keys. The client should not generate the hash key value. Instead, the client should query on the Credential Group Keys collection resource with a filter on the primary key values in order to navigate to a specific instance of Credential Group Keys.
  
  For example: publicSectorCredentialGroupsKeys?q=AgencyId=<value1>;CredGroupId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : publicSectorCredentialGroupsKeys-item-response

Type: object

Show Source

• AgencyId: integer
  Read Only: true

  The unique identifier for a public sector agency.
• CredGroupId: string
  Read Only: true

  Maximum Length: 50

  The unique name that identifies a credential group.
• Description: string
  Read Only: true

  Maximum Length: 200

  The long description of the credential group.
• EffectiveEndDate: string (date)
  Read Only: true

  The date at the end of the date range within which the credential group is effective.
• EffectiveStartDate: string (date)
  Read Only: true

  The date at the beginning of the date range within which the credential group is effective.
• EnabledFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the credential group is enabled or not.
• GroupName: string
  Read Only: true

  Maximum Length: 100

  The short description of the credential group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for a public sector agency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CredGroupId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique name that identifies a credential group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":200,
            "type":"string",
            "description":"The long description of the credential group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The date at the end of the date range within which the credential group is effective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The date at the beginning of the date range within which the credential group is effective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the credential group is enabled or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupName":{
            "maxLength":100,
            "type":"string",
            "description":"The short description of the credential group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top