Jump to

• Request
• Response

Create a set of credentials

post

/fscmRestApi/resources/11.13.18.05/publicSectorCredentials

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier for a public sector agency.
• CredCode(required): string
  Title: Credential Code

  Maximum Length: 30

  The unique identifier for credential code.
• CredentialAttribute: array Credential Attributes
  Title: Credential Attributes

  The credential attributes resource is used to view, add, delete, and modify information for a credential attribute.
• Description: string
  Title: Description

  Maximum Length: 200

  The long description for a credential.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

  Indicates whether the credential is enabled.
• ShortDescr(required): string
  Title: Short Description

  Maximum Length: 100

  The short description for a credential.

{
    "required":[
        "CredCode",
        "ShortDescr"
    ],
    "type":"object",
    "properties":{
        "ShortDescr":{
            "title":"Short Description",
            "maxLength":"100",
            "type":"string",
            "description":"The short description for a credential.",
            "nullable":false
        },
        "CredentialAttribute":{
            "title":"Credential Attributes",
            "type":"array",
            "description":"The credential attributes resource is used to view, add, delete, and modify information for a credential attribute.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCredentials-CredentialAttribute-item-post-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"200",
            "type":"string",
            "description":"The long description for a credential.",
            "nullable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "CredCode":{
            "title":"Credential Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for credential code.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the credential is enabled.",
            "nullable":false,
            "default":"Y"
        }
    }
}

Nested Schema : Credential Attributes

Type: array

Title: Credential Attributes

The credential attributes resource is used to view, add, delete, and modify information for a credential attribute.

Show Source

• Array of: object publicSectorCredentials-CredentialAttribute-item-post-request

{
    "title":"Credential Attributes",
    "type":"array",
    "description":"The credential attributes resource is used to view, add, delete, and modify information for a credential attribute.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCredentials-CredentialAttribute-item-post-request"
    }
}

Nested Schema : publicSectorCredentials-CredentialAttribute-item-post-request

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

  The unique name that identifies an attribute for a credential.
• CredCode: string
  Title: Credential Code

  Maximum Length: 30

  The unique name that identifies a credential.
• 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.

{
    "type":"object",
    "properties":{
        "AttributeCode":{
            "title":"Attribute Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique name that identifies an attribute for a credential.",
            "nullable":false
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the credential attribute is required or not.",
            "nullable":false,
            "default":"N"
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "CredCode":{
            "title":"Credential Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique name that identifies a credential.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the credential attribute is enabled or not.",
            "nullable":false,
            "default":"N"
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier for a public sector agency.
• CredCode: string
  Title: Credential Code

  Maximum Length: 30

  The unique identifier for credential code.
• CredentialAttribute: array Credential Attributes
  Title: Credential Attributes

  The credential attributes resource is used to view, add, delete, and modify information for a credential attribute.
• Description: string
  Title: Description

  Maximum Length: 200

  The long description for a credential.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

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

  The link relations associated with the resource instance.
• ShortDescr: string
  Title: Short Description

  Maximum Length: 100

  The short description for a credential.

{
    "type":"object",
    "properties":{
        "ShortDescr":{
            "title":"Short Description",
            "maxLength":"100",
            "type":"string",
            "description":"The short description for a credential.",
            "nullable":false,
            "x-queryable":true
        },
        "CredentialAttribute":{
            "title":"Credential Attributes",
            "type":"array",
            "description":"The credential attributes resource is used to view, add, delete, and modify information for a credential attribute.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCredentials-CredentialAttribute-item-response"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"200",
            "type":"string",
            "description":"The long description for a credential.",
            "nullable":true,
            "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
        },
        "CredCode":{
            "title":"Credential Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for credential code.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the credential is enabled.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        }
    }
}

Nested Schema : Credential Attributes

Type: array

Title: Credential Attributes

The credential attributes resource is used to view, add, delete, and modify information for a credential attribute.

Show Source

• Array of: object publicSectorCredentials-CredentialAttribute-item-response

{
    "title":"Credential Attributes",
    "type":"array",
    "description":"The credential attributes resource is used to view, add, delete, and modify information for a credential attribute.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCredentials-CredentialAttribute-item-response"
    }
}

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 : publicSectorCredentials-CredentialAttribute-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

  The unique name that identifies an attribute for a credential.
• CredCode: string
  Title: Credential Code

  Maximum Length: 30

  The unique name that identifies a credential.
• 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.

{
    "type":"object",
    "properties":{
        "AttributeCode":{
            "title":"Attribute Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique name that identifies an attribute for a credential.",
            "nullable":false,
            "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
        },
        "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
        },
        "CredCode":{
            "title":"Credential Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique name that identifies a credential.",
            "nullable":false,
            "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."
        }
    }
}

Links

CredentialAttribute

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorCredentials/{publicSectorCredentialsUniqID}/child/CredentialAttribute

Parameters:

• publicSectorCredentialsUniqID: $request.path.publicSectorCredentialsUniqID

The credential attributes resource is used to view, add, delete, and modify information for a credential attribute.

Back to Top