Jump to

• Request
• Response

Update a token

patch

/fscmRestApi/resources/11.13.18.05/publicSectorTokens/{ReqId}

Request

Path Parameters

• ReqId(required): integer(int64)
  The unique request ID.

Header Parameters

• Metadata-Context: string
  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: string
  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

• 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.

{
    "type":"object",
    "properties":{
        "Attempts":{
            "type":"integer",
            "description":"The number of attempts made to validate a token. This attribute is valid only for multi-use tokens.",
            "nullable":true
        },
        "ExpiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicating whether the token has expired.",
            "nullable":true
        },
        "ExpiryTime":{
            "type":"integer",
            "description":"The time in hours for which the token will be valid. The default is four hours.",
            "nullable":true
        },
        "LastAttempt":{
            "type":"string",
            "description":"The time stamp of last attempt to validate token.",
            "format":"date-time",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "nullable":false
        },
        "ReqId":{
            "type":"integer",
            "description":"The unique request ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SingleUseFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicating whether the token is single-use or not. The default value is T for true.",
            "nullable":true
        },
        "Token":{
            "maxLength":64,
            "type":"string",
            "description":"The token generated for verification.",
            "nullable":false
        },
        "TokenIdentifier":{
            "maxLength":256,
            "type":"string",
            "description":"The value passed by the clients to identify the token.",
            "nullable":false
        },
        "TokenOwner":{
            "maxLength":64,
            "type":"string",
            "description":"The value passed by the clients identifying the application or module that owns the token.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Attempts":{
            "type":"integer",
            "description":"The number of attempts made to validate a token. This attribute is valid only for multi-use tokens.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicating whether the token has expired.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryTime":{
            "type":"integer",
            "description":"The time in hours for which the token will be valid. The default is four hours.",
            "nullable":true,
            "x-queryable":true
        },
        "LastAttempt":{
            "type":"string",
            "description":"The time stamp of last attempt to validate token.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The session login associated with the user who last updated the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date and time of the last update of the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ReqId":{
            "type":"integer",
            "description":"The unique request ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SingleUseFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicating whether the token is single-use or not. The default value is T for true.",
            "nullable":true,
            "x-queryable":true
        },
        "Token":{
            "maxLength":64,
            "type":"string",
            "description":"The token generated for verification.",
            "nullable":false,
            "x-queryable":true
        },
        "TokenIdentifier":{
            "maxLength":256,
            "type":"string",
            "description":"The value passed by the clients to identify the token.",
            "nullable":false,
            "x-queryable":true
        },
        "TokenOwner":{
            "maxLength":64,
            "type":"string",
            "description":"The value passed by the clients identifying the application or module that owns the token.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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