Jump to

• Request
• Response

Update a credential layout attribute

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCredentialLayouts/{publicSectorCredentialLayoutsUniqID}

Request

Path Parameters

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

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AttributeLabel: string
  Maximum Length: 120

  The label for a credential layout attribute.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Default Value: N

  Indicates whether the credential attribute is enabled or not.
• RequiredFlag: string
  Title: Required

  Maximum Length: 1

  Default Value: N

  Indicates whether the credential attribute is required or not.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates whether the row is seed data.The valid values are 0, 1, and 2 and they represent 0= customer data, 1= seed data cannot be modified, and 2= seed data can be modified.

{
    "type":"object",
    "properties":{
        "AttributeLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"The label for a credential layout attribute.",
            "nullable":false
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the credential attribute is required or not.",
            "nullable":false,
            "default":"N"
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the credential attribute is enabled or not.",
            "nullable":false,
            "default":"N"
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates whether the row is seed data.The valid values are 0, 1, and 2 and they represent 0= customer data, 1= seed data cannot be modified, and 2=  seed data can be modified.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            }
        }
    }
}

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 : publicSectorCredentialLayouts-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier for a public sector agency.
• AttributeCode: string
  Title: Attribute Code

  Maximum Length: 30

  A unique value that identifies the credential attribute.
• AttributeLabel: string
  Maximum Length: 120

  The label for a credential layout attribute.
• AttributeLength: integer (int64)
  Title: Length

  Read Only: true

  The length of a credential layout attribute.
• AttributeType: string
  Title: Type

  Read Only: true

  Maximum Length: 128

  The type of a credential layout attribute.
• DeletedFlag: string
  Read Only: true

  Maximum Length: 1

  Default Value: N

  Indicates whether the record is logically deleted (Y or N). The valid values are Y = deleted record, and N=active record. The default value is N.
• DisplaySequence: integer (int64)
  Read Only: true

  The display of a credential layout attribute.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Default Value: N

  Indicates whether the credential attribute is enabled or not.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequiredFlag: string
  Title: Required

  Maximum Length: 1

  Default Value: N

  Indicates whether the credential attribute is required or not.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates whether the row is seed data.The valid values are 0, 1, and 2 and they represent 0= customer data, 1= seed data cannot be modified, and 2= seed data can be modified.

{
    "type":"object",
    "properties":{
        "AttributeLength":{
            "title":"Length",
            "type":"integer",
            "description":"The length of a credential layout attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"22"
            },
            "x-queryable":true
        },
        "AttributeCode":{
            "title":"Attribute Code",
            "maxLength":"30",
            "type":"string",
            "description":"A unique value that identifies the credential attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"The label for a credential layout attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"The display of a credential layout attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeType":{
            "title":"Type",
            "maxLength":"128",
            "type":"string",
            "description":"The type of a credential layout attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates whether the row is seed data.The valid values are 0, 1, and 2 and they represent 0= customer data, 1= seed data cannot be modified, and 2=  seed data can be modified.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is logically deleted (Y or N). The valid values are Y = deleted record,  and N=active record. The default value is N.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the credential attribute is required or not.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the credential attribute is enabled or not.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        }
    }
}

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