Create a token
post
/fscmRestApi/resources/11.13.18.05/publicSectorTokens
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
-
Attempts: integer
The number of attempts made to validate a token. This attribute is valid only for multi-use tokens.
-
ExpiredFlag: boolean
Maximum Length:
1
The flag indicating whether the token has expired. -
ExpiryTime: integer
The time in hours for which the token will be valid. The default is four hours.
-
LastAttempt: string
(date-time)
The time stamp of last attempt to validate token.
-
ObjectVersionNumber: integer
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
ReqId: integer
(int64)
The unique request ID.
-
SingleUseFlag: boolean
Maximum Length:
1
The flag indicating whether the token is single-use or not. The default value is T for true. -
Token: string
Maximum Length:
64
The token generated for verification. -
TokenIdentifier: string
Maximum Length:
256
The value passed by the clients to identify the token. -
TokenOwner: string
Maximum Length:
64
The value passed by the clients identifying the application or module that owns the token.
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 : publicSectorTokens-item-response
Type:
Show Source
object
-
Attempts: integer
The number of attempts made to validate a token. This attribute is valid only for multi-use tokens.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date and time the row was created. -
ExpiredFlag: boolean
Maximum Length:
1
The flag indicating whether the token has expired. -
ExpiryTime: integer
The time in hours for which the token will be valid. The default is four hours.
-
LastAttempt: string
(date-time)
The time stamp of last attempt to validate token.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The session login associated with the user who last updated the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The date and time of the last update of the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
ReqId: integer
(int64)
The unique request ID.
-
SingleUseFlag: boolean
Maximum Length:
1
The flag indicating whether the token is single-use or not. The default value is T for true. -
Token: string
Maximum Length:
64
The token generated for verification. -
TokenIdentifier: string
Maximum Length:
256
The value passed by the clients to identify the token. -
TokenOwner: string
Maximum Length:
64
The value passed by the clients identifying the application or module that owns the token.
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.