Create a set of credential group definitions
post
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupsTotals
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
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorCredentialGroupsTotals-item-response
Type:
Show Source
object
-
AgencyId: integer
Read Only:
true
The unique identifier for a public sector agency. -
BusLicensingFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the credential group is applicable for business license application or not. -
CredGroupId: string
Title:
Group ID
Read Only:true
Maximum Length:50
A 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.
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.