Jump to

• Request
• Response

Create a digital payment account assignment

post

/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/{PayeeId}/child/digitalPaymentAccountAssignments

Request

Path Parameters

• PayeeId(required): integer(int64)
  Application-generated identifier of the external payee.

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.
• Upsert-Mode: string
  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

• AliasFive: string
  Title: Alias

  Maximum Length: 150

  Additional alias used to represent the virtual card digital payment account.
• AliasFour: string
  Title: Alias

  Maximum Length: 150

  Additional alias used to represent the virtual card digital payment account.
• AliasOne: string
  Title: Alias

  Maximum Length: 150

  Alias used to represent the digital payment account.
• AliasThree: string
  Title: Alias

  Maximum Length: 150

  Additional alias used to represent the digital payment account.
• AliasTwo: string
  Title: Alias

  Maximum Length: 150

  Additional alias used to represent the digital payment account.
• BankAccount: string
  Title: Bank Account

  Maximum Length: 100

  Bank account assigned to the digital payment account.
• CountryCode: string
  Title: Country Code

  Maximum Length: 2

  Country code of the digital payment account.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  Currency code of the digital payment account.
• DigitalAccountProviderStatus: string
  Title: Registration Status

  Maximum Length: 80

  Registration status of the provider for the digital payment account.
• DigitalPaymentAccount: string
  Title: Display Name

  Maximum Length: 150

  Display name of the digital payment account.
• DigitalPaymentAccountId: integer
  Title: Digital Payment Account ID

  Unique identifier of the digital payment account.
• EndDate: string (date)
  Title: End Date

  The date when the relationship between the payment instrument and the payer or payee becomes inactive in the payment instrument assignment.
• ExpirationDate: string (date)
  Title: Inactive On

  The date when the digital payment account expires.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 30

  Indicates whether the payment instrument is the primary payment instrument for the payer or payee within the instrument assignment. A primary payment instrument automatically populates the transactions.
• RemitAdviceIdentifierFive: string
  Title: Remit Advice Identifier

  Maximum Length: 150

  Additional unique identifier for a separate remittance advice.
• RemitAdviceIdentifierFour: string
  Title: Remit Advice Identifier

  Maximum Length: 150

  Additional unique identifier for separate remittance advice.
• RemitAdviceIdentifierOne: string
  Title: Remit Advice Identifier

  Maximum Length: 150

  Remittance advice identifier used for separate remittance advice processing.
• RemitAdviceIdentifierThree: string
  Title: Remit Advice Identifier

  Maximum Length: 150

  Additional unique identifier for a separate remittance advice.
• RemitAdviceIdentifierTwo: string
  Title: Remit Advice Identifier

  Maximum Length: 150

  Additional remittance advice identifier used for separate remittance advice processing.
• StartDate: string (date)
  Title: Start Date

  The date when the relationship between the payment instrument and the payer or payee becomes active in the payment instrument assignment.
• Token: string
  Title: Token

  Maximum Length: 150

  Substitute identifier of the digital payment account.
• VirtualCardProgram: string
  Title: Card Program

  Maximum Length: 100

  Virtual card program associated with the digital payment account.

{
    "type":"object",
    "properties":{
        "AliasFive":{
            "title":"Alias",
            "maxLength":150,
            "type":"string",
            "description":"Additional alias used to represent the virtual card digital payment account.",
            "nullable":true
        },
        "AliasFour":{
            "title":"Alias",
            "maxLength":150,
            "type":"string",
            "description":"Additional alias used to represent the virtual card digital payment account.",
            "nullable":true
        },
        "AliasOne":{
            "title":"Alias",
            "maxLength":150,
            "type":"string",
            "description":"Alias used to represent the digital payment account.",
            "nullable":true
        },
        "AliasThree":{
            "title":"Alias",
            "maxLength":150,
            "type":"string",
            "description":"Additional alias used to represent the digital payment account.",
            "nullable":true
        },
        "AliasTwo":{
            "title":"Alias",
            "maxLength":150,
            "type":"string",
            "description":"Additional alias used to represent the digital payment account.",
            "nullable":true
        },
        "BankAccount":{
            "title":"Bank Account",
            "maxLength":100,
            "type":"string",
            "description":"Bank account assigned to the digital payment account.",
            "nullable":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ExtBankAccountIdBA"
                ]
            }
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":2,
            "type":"string",
            "description":"Country code of the digital payment account.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Currency code of the digital payment account.",
            "nullable":true
        },
        "DigitalAccountProviderStatus":{
            "title":"Registration Status",
            "maxLength":80,
            "type":"string",
            "description":"Registration status of the provider for the digital payment account.",
            "nullable":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "LookupCodePS"
                ]
            }
        },
        "DigitalPaymentAccount":{
            "title":"Display Name",
            "maxLength":150,
            "type":"string",
            "description":"Display name of the digital payment account.",
            "nullable":true
        },
        "DigitalPaymentAccountId":{
            "title":"Digital Payment Account ID",
            "type":"integer",
            "description":"Unique identifier of the digital payment account.",
            "nullable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the relationship between the payment instrument and the payer or payee becomes inactive in the payment instrument assignment.",
            "format":"date",
            "nullable":true
        },
        "ExpirationDate":{
            "title":"Inactive On",
            "type":"string",
            "description":"The date when the digital payment account expires.",
            "format":"date",
            "nullable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the payment instrument is the primary payment instrument for the payer or payee within the instrument assignment. A primary payment instrument automatically populates the transactions.",
            "nullable":true
        },
        "RemitAdviceIdentifierFive":{
            "title":"Remit Advice Identifier",
            "maxLength":150,
            "type":"string",
            "description":"Additional unique identifier for a separate remittance advice.",
            "nullable":true
        },
        "RemitAdviceIdentifierFour":{
            "title":"Remit Advice Identifier",
            "maxLength":150,
            "type":"string",
            "description":"Additional unique identifier for separate remittance advice.",
            "nullable":true
        },
        "RemitAdviceIdentifierOne":{
            "title":"Remit Advice Identifier",
            "maxLength":150,
            "type":"string",
            "description":"Remittance advice identifier used for separate remittance advice processing.",
            "nullable":true
        },
        "RemitAdviceIdentifierThree":{
            "title":"Remit Advice Identifier",
            "maxLength":150,
            "type":"string",
            "description":"Additional unique identifier for a separate remittance advice.",
            "nullable":true
        },
        "RemitAdviceIdentifierTwo":{
            "title":"Remit Advice Identifier",
            "maxLength":150,
            "type":"string",
            "description":"Additional remittance advice identifier used for separate remittance advice processing.",
            "nullable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the relationship between the payment instrument and the payer or payee becomes active in the payment instrument assignment.",
            "format":"date",
            "nullable":false
        },
        "Token":{
            "title":"Token",
            "maxLength":150,
            "type":"string",
            "description":"Substitute identifier of the digital payment account.",
            "nullable":true
        },
        "VirtualCardProgram":{
            "title":"Card Program",
            "maxLength":100,
            "type":"string",
            "description":"Virtual card program associated with the digital payment account.",
            "nullable":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "VcardProgramId"
                ]
            }
        }
    }
}

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 : paymentsExternalPayees-digitalPaymentAccountAssignments-item-response

Type: object

Show Source

• AccountUsageType: string
  Title: Account Usage Type

  Read Only: true

  Maximum Length: 80

  Purpose of the digital payment account.
• AliasFive: string
  Title: Alias

  Maximum Length: 150

  Additional alias used to represent the virtual card digital payment account.
• AliasFour: string
  Title: Alias

  Maximum Length: 150

  Additional alias used to represent the virtual card digital payment account.
• AliasOne: string
  Title: Alias

  Maximum Length: 150

  Alias used to represent the digital payment account.
• AliasThree: string
  Title: Alias

  Maximum Length: 150

  Additional alias used to represent the digital payment account.
• AliasTwo: string
  Title: Alias

  Maximum Length: 150

  Additional alias used to represent the digital payment account.
• AliasType: string
  Title: Alias Type

  Read Only: true

  Maximum Length: 80

  Type of alias used to represent the digital payment account.
• BankAccount: string
  Title: Bank Account

  Maximum Length: 100

  Bank account assigned to the digital payment account.
• CardPlatform: string
  Title: Card Platform

  Read Only: true

  Maximum Length: 80

  Name of the payment system used by the virtual card program.
• CountryCode: string
  Title: Country Code

  Maximum Length: 2

  Country code of the digital payment account.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the digital payment account assignment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the digital payment account assignment was created.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  Currency code of the digital payment account.
• DigitalAccountProviderStatus: string
  Title: Registration Status

  Maximum Length: 80

  Registration status of the provider for the digital payment account.
• DigitalPaymentAccount: string
  Title: Display Name

  Maximum Length: 150

  Display name of the digital payment account.
• DigitalPaymentAccountId: integer
  Title: Digital Payment Account ID

  Unique identifier of the digital payment account.
• EndDate: string (date)
  Title: End Date

  The date when the relationship between the payment instrument and the payer or payee becomes inactive in the payment instrument assignment.
• ExpirationDate: string (date)
  Title: Inactive On

  The date when the digital payment account expires.
• InstrumentAssignmentId: integer (int64)
  Title: Instrument Payment Use ID

  Read Only: true

  Unique identifier of the instrument assignment.
• InstrumentType: string
  Title: Instrument Type

  Read Only: true

  Maximum Length: 80

  Type of payment instrument used in the instrument assignment.
• IssueDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the digital payment account was issued.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the digital payment account assignment was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the digital payment account assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwnerParty: string
  Title: Owner Party Name

  Read Only: true

  Maximum Length: 360

  Party name of the digital payment account owner.
• OwnerPartyNumber: string
  Title: Owner Party Number

  Read Only: true

  Maximum Length: 30

  Party number of the digital payment account owner.
• PaymentFlow: string
  Title: Payment Flow

  Read Only: true

  Maximum Length: 80

  Payment flow that determines whether the instrument assignment is used for outgoing or incoming payments.
• PaymentMode: string
  Title: Payment Mode

  Read Only: true

  Maximum Length: 80

  Payment method used by the digital payment account.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 30

  Indicates whether the payment instrument is the primary payment instrument for the payer or payee within the instrument assignment. A primary payment instrument automatically populates the transactions.
• RemitAdviceIdentifierFive: string
  Title: Remit Advice Identifier

  Maximum Length: 150

  Additional unique identifier for a separate remittance advice.
• RemitAdviceIdentifierFour: string
  Title: Remit Advice Identifier

  Maximum Length: 150

  Additional unique identifier for separate remittance advice.
• RemitAdviceIdentifierOne: string
  Title: Remit Advice Identifier

  Maximum Length: 150

  Remittance advice identifier used for separate remittance advice processing.
• RemitAdviceIdentifierThree: string
  Title: Remit Advice Identifier

  Maximum Length: 150

  Additional unique identifier for a separate remittance advice.
• RemitAdviceIdentifierTwo: string
  Title: Remit Advice Identifier

  Maximum Length: 150

  Additional remittance advice identifier used for separate remittance advice processing.
• RemitAdviceIdentifierType: string
  Title: Remit Advice Identifier Type

  Read Only: true

  Maximum Length: 80

  Type of remittance advice identifier assigned to the digital payment account.
• StartDate: string (date)
  Title: Start Date

  The date when the relationship between the payment instrument and the payer or payee becomes active in the payment instrument assignment.
• StraightThroughProcessingFlag: boolean
  Title: Straight Through Processing

  Read Only: true

  Maximum Length: 1

  Indicates whether straight through processing is enabled for the digital payment account.
• Token: string
  Title: Token

  Maximum Length: 150

  Substitute identifier of the digital payment account.
• TokenType: string
  Title: Token Type

  Read Only: true

  Maximum Length: 80

  Type of token assigned to the digital payment account.
• VirtualCardProgram: string
  Title: Card Program

  Maximum Length: 100

  Virtual card program associated with the digital payment account.

{
    "type":"object",
    "properties":{
        "AccountUsageType":{
            "title":"Account Usage Type",
            "maxLength":80,
            "type":"string",
            "description":"Purpose of the digital payment account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "LookupCodeAU"
                ]
            },
            "x-queryable":true
        },
        "AliasFive":{
            "title":"Alias",
            "maxLength":150,
            "type":"string",
            "description":"Additional alias used to represent the virtual card digital payment account.",
            "nullable":true,
            "x-queryable":true
        },
        "AliasFour":{
            "title":"Alias",
            "maxLength":150,
            "type":"string",
            "description":"Additional alias used to represent the virtual card digital payment account.",
            "nullable":true,
            "x-queryable":true
        },
        "AliasOne":{
            "title":"Alias",
            "maxLength":150,
            "type":"string",
            "description":"Alias used to represent the digital payment account.",
            "nullable":true,
            "x-queryable":true
        },
        "AliasThree":{
            "title":"Alias",
            "maxLength":150,
            "type":"string",
            "description":"Additional alias used to represent the digital payment account.",
            "nullable":true,
            "x-queryable":true
        },
        "AliasTwo":{
            "title":"Alias",
            "maxLength":150,
            "type":"string",
            "description":"Additional alias used to represent the digital payment account.",
            "nullable":true,
            "x-queryable":true
        },
        "AliasType":{
            "title":"Alias Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of alias used to represent the digital payment account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "LookupCodeAT"
                ]
            },
            "x-queryable":true
        },
        "BankAccount":{
            "title":"Bank Account",
            "maxLength":100,
            "type":"string",
            "description":"Bank account assigned to the digital payment account.",
            "nullable":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ExtBankAccountIdBA"
                ]
            },
            "x-queryable":true
        },
        "CardPlatform":{
            "title":"Card Platform",
            "maxLength":80,
            "type":"string",
            "description":"Name of the payment system used by the virtual card program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":2,
            "type":"string",
            "description":"Country code of the digital payment account.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the digital payment account assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the digital payment account assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Currency code of the digital payment account.",
            "nullable":true,
            "x-queryable":true
        },
        "DigitalAccountProviderStatus":{
            "title":"Registration Status",
            "maxLength":80,
            "type":"string",
            "description":"Registration status of the provider for the digital payment account.",
            "nullable":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "LookupCodePS"
                ]
            },
            "x-queryable":true
        },
        "DigitalPaymentAccount":{
            "title":"Display Name",
            "maxLength":150,
            "type":"string",
            "description":"Display name of the digital payment account.",
            "nullable":true,
            "x-queryable":true
        },
        "DigitalPaymentAccountId":{
            "title":"Digital Payment Account ID",
            "type":"integer",
            "description":"Unique identifier of the digital payment account.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the relationship between the payment instrument and the payer or payee becomes inactive in the payment instrument assignment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Inactive On",
            "type":"string",
            "description":"The date when the digital payment account expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InstrumentAssignmentId":{
            "title":"Instrument Payment Use ID",
            "type":"integer",
            "description":"Unique identifier of the instrument assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InstrumentType":{
            "title":"Instrument Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of payment instrument used in the instrument assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the digital payment account was issued.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the digital payment account assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the digital payment account assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerParty":{
            "title":"Owner Party Name",
            "maxLength":360,
            "type":"string",
            "description":"Party name of the digital payment account owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPartyNumber":{
            "title":"Owner Party Number",
            "maxLength":30,
            "type":"string",
            "description":"Party number of the digital payment account owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentFlow":{
            "title":"Payment Flow",
            "maxLength":80,
            "type":"string",
            "description":"Payment flow that determines whether the instrument assignment is used for outgoing or incoming payments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentMode":{
            "title":"Payment Mode",
            "maxLength":80,
            "type":"string",
            "description":"Payment method used by the digital payment account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the payment instrument is the primary payment instrument for the payer or payee within the instrument assignment. A primary payment instrument automatically populates the transactions.",
            "nullable":true,
            "x-queryable":true
        },
        "RemitAdviceIdentifierFive":{
            "title":"Remit Advice Identifier",
            "maxLength":150,
            "type":"string",
            "description":"Additional unique identifier for a separate remittance advice.",
            "nullable":true,
            "x-queryable":true
        },
        "RemitAdviceIdentifierFour":{
            "title":"Remit Advice Identifier",
            "maxLength":150,
            "type":"string",
            "description":"Additional unique identifier for separate remittance advice.",
            "nullable":true,
            "x-queryable":true
        },
        "RemitAdviceIdentifierOne":{
            "title":"Remit Advice Identifier",
            "maxLength":150,
            "type":"string",
            "description":"Remittance advice identifier used for separate remittance advice processing.",
            "nullable":true,
            "x-queryable":true
        },
        "RemitAdviceIdentifierThree":{
            "title":"Remit Advice Identifier",
            "maxLength":150,
            "type":"string",
            "description":"Additional unique identifier for a separate remittance advice.",
            "nullable":true,
            "x-queryable":true
        },
        "RemitAdviceIdentifierTwo":{
            "title":"Remit Advice Identifier",
            "maxLength":150,
            "type":"string",
            "description":"Additional remittance advice identifier used for separate remittance advice processing.",
            "nullable":true,
            "x-queryable":true
        },
        "RemitAdviceIdentifierType":{
            "title":"Remit Advice Identifier Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of remittance advice identifier assigned to the digital payment account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the relationship between the payment instrument and the payer or payee becomes active in the payment instrument assignment.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "StraightThroughProcessingFlag":{
            "title":"Straight Through Processing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether straight through processing is enabled for the digital payment account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "Bepid",
                    "Token",
                    "TokenTypeCode"
                ]
            }
        },
        "Token":{
            "title":"Token",
            "maxLength":150,
            "type":"string",
            "description":"Substitute identifier of the digital payment account.",
            "nullable":true,
            "x-queryable":true
        },
        "TokenType":{
            "title":"Token Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of token assigned to the digital payment account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "LookupCodeTT"
                ]
            },
            "x-queryable":true
        },
        "VirtualCardProgram":{
            "title":"Card Program",
            "maxLength":100,
            "type":"string",
            "description":"Virtual card program associated with the digital payment account.",
            "nullable":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "VcardProgramId"
                ]
            },
            "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