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
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
ApplyToInProcessTrans: string
Title:
Apply conditions to transactions
Maximum Length:1
Default Value:N
Indicates whether the in-process transactions will inherit this condition. -
ConditionName: string
Title:
Business License Condition
Maximum Length:50
The business license condition name to be applied when the credential expires. -
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. -
InheritFlag: string
Title:
Include in-process transactions
Maximum Length:1
Default Value:N
Indicates whether the condition will be inherited. -
ShortDescr(required): string
Title:
Short Description
Maximum Length:100
The short description for a credential.
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
Nested Schema : publicSectorCredentials-CredentialAttribute-item-post-request
Type:
Show Source
object
-
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.
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.
Root Schema : publicSectorCredentials-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
ApplyToInProcessTrans: string
Title:
Apply conditions to transactions
Maximum Length:1
Default Value:N
Indicates whether the in-process transactions will inherit this condition. -
ConditionName: string
Title:
Business License Condition
Maximum Length:50
The business license condition name to be applied when the credential expires. -
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. -
InheritFlag: string
Title:
Include in-process transactions
Maximum Length:1
Default Value:N
Indicates whether the condition will be inherited. -
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.
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCredentials-CredentialAttribute-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- CredentialAttribute
-
Parameters:
- publicSectorCredentialsUniqID:
$request.path.publicSectorCredentialsUniqID
The credential attributes resource is used to view, add, delete, and modify information for a credential attribute. - publicSectorCredentialsUniqID: