Jump to

• Request
• Response

Create transactions

post

/fscmRestApi/resources/11.13.18.05/genealogyObjects/{GenealogyInstanceId}/child/genealogyTransactions

Request

Path Parameters

• GenealogyInstanceId(required): integer(int64)
  Value that uniquely identifies a genealogy object instance. This is a primary key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Document: string
  Maximum Length: 240

  Name that identifies the document that the transaction references.
• DocumentType: string
  Maximum Length: 30

  Value that identifies the document type that the transaction references.
• GenealogyTransactionId: integer (int64)
  Value that uniquely identifies a genealogy transaction.
• InventoryLocatorId: integer (int64)
  Value that uniquely identifies the locator of the transaction subinventory.
• LocationContext: string
  Maximum Length: 30

  Description of the location of the transaction.
• LocationName: string
  Maximum Length: 255

  Name of the location of the transaction.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization where the transaction occurs.
• Quantity: number
  Quantity of transaction of the genealogy object instance.
• SourceSystem: string
  Name of the source application that is the origin of the transaction.
• SourceSystemId: integer (int64)
  Value that uniquely identifies the source application that is the origin of the transaction. This attribute is read-only.
• SourceSystemTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of source application that is the origin of the transaction. A list of accepted values is defined in the lookup type ORA_CSE_SOURCE_SYSTEM_TYPE. Valid value is ORA_EXTERNAL.
• SourceTransactionDate: string (date-time)
  Date when the source transaction occurred.
• SourceTransactionId: number
  Value that identifies the source transaction.
• SourceTransactionType: string
  Maximum Length: 240

  Name of the type of source transaction.
• SourceTransactionTypeId: string
  Maximum Length: 30

  Value that uniquely identifies the type of source transaction.
• Subinventory: string
  Maximum Length: 10

  Name of the transaction subinventory.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the quantity of the transaction.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center that is the location of the transaction.
• WorkOrderId: integer (int64)
  Value that uniquely identifies the work order that is the location of the transaction.
• WorkOrderNumber: string
  Maximum Length: 255

  Number that identifies the work order.
• WorkOrderOperation: string
  Maximum Length: 255

  Name of the work order operation.
• WorkOrderOperationId: integer (int64)
  Value that uniquely identifies the work order operation.

{
    "type":"object",
    "properties":{
        "WorkOrderOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center that is the location of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "WorkOrderOperation":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the work order operation.",
            "nullable":true
        },
        "InventoryLocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator of the transaction subinventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of transaction of the genealogy object instance.",
            "nullable":true
        },
        "DocumentType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the document type that the transaction references.",
            "nullable":false
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization where the transaction occurs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "GenealogyTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies a genealogy transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SourceSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source application that is the origin of the transaction. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceTransactionType":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the type of source transaction.",
            "nullable":true
        },
        "Document":{
            "maxLength":"240",
            "type":"string",
            "description":"Name that identifies the document that the transaction references.",
            "nullable":true
        },
        "SourceTransactionTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the type of source transaction.",
            "nullable":true
        },
        "LocationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the location of the transaction.",
            "nullable":true
        },
        "WorkOrderNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the work order.",
            "nullable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order that is the location of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "Subinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the transaction subinventory.",
            "nullable":true
        },
        "SourceTransactionDate":{
            "type":"string",
            "description":"Date when the source transaction occurred.",
            "format":"date-time",
            "nullable":false
        },
        "SourceSystemTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of source application that is the origin of the transaction. A list of accepted values is defined in the lookup type ORA_CSE_SOURCE_SYSTEM_TYPE. Valid value is ORA_EXTERNAL.",
            "nullable":true
        },
        "SourceTransactionId":{
            "type":"number",
            "description":"Value that identifies the source transaction.",
            "nullable":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "LocationContext":{
            "maxLength":"30",
            "type":"string",
            "description":"Description of the location of the transaction.",
            "nullable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"Name of the source application that is the origin of the transaction.",
            "nullable":true
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the quantity of the transaction.",
            "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 : genealogyObjects-genealogyTransactions-item-response

Type: object

Show Source

• CustomerId: integer (int64)
  Read Only: true

  Value that uniquely identifies the customer who bought the genealogy object instance.
• CustomerName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Name of the customer who bought the genealogy object instance.
• CustomerNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  Number that identifies the customer who bought the genealogy object instance.
• CustomerSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the customer site that is the location of the transaction.
• CustomerSiteName: string
  Title: Site Name

  Read Only: true

  Maximum Length: 240

  Name of the customer site that is the location of the transaction.
• CustomerSiteNumber: string
  Title: Site Number

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the customer site that is the location of the transaction.
• CustomerSiteParty: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Name of the customer party site that is the location of the transaction.
• CustomerSitePartyId: integer (int64)
  Read Only: true

  Value that uniquely identifies the customer party site that is the location of the transaction.
• CustomerSitePartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the customer party site that is the location of the transaction.
• Document: string
  Maximum Length: 240

  Name that identifies the document that the transaction references.
• DocumentType: string
  Maximum Length: 30

  Value that identifies the document type that the transaction references.
• ExternalLocation: string
  Read Only: true

  Maximum Length: 240

  Value that identifies the location of the transaction. This location can be an external address location or a value that is not validated against any location types defined in the application.
• GenealogyTransactionId: integer (int64)
  Value that uniquely identifies a genealogy transaction.
• InventoryLocatorId: integer (int64)
  Value that uniquely identifies the locator of the transaction subinventory.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationCode: string
  Read Only: true

  Maximum Length: 80

  Abbreviation that identifies the location of the transaction.
• LocationContext: string
  Maximum Length: 30

  Description of the location of the transaction.
• LocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the location of the transaction.
• LocationName: string
  Maximum Length: 255

  Name of the location of the transaction.
• LocationOrganization: string
  Read Only: true

  Maximum Length: 240

  Name of the transaction location organization.
• LocationOrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the transaction location organization.
• LocationOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifier the transaction location organization.
• Organization: string
  Read Only: true

  Maximum Length: 240

  Name of the organization where the transaction occurs.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the organization where the transaction occurs.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization where the transaction occurs.
• Quantity: number
  Quantity of transaction of the genealogy object instance.
• SourceSystem: string
  Name of the source application that is the origin of the transaction.
• SourceSystemId: integer (int64)
  Value that uniquely identifies the source application that is the origin of the transaction. This attribute is read-only.
• SourceSystemType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Description of the type of source application. This attribute is read-only.
• SourceSystemTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of source application that is the origin of the transaction. A list of accepted values is defined in the lookup type ORA_CSE_SOURCE_SYSTEM_TYPE. Valid value is ORA_EXTERNAL.
• SourceTransactionDate: string (date-time)
  Date when the source transaction occurred.
• SourceTransactionId: number
  Value that identifies the source transaction.
• SourceTransactionType: string
  Maximum Length: 240

  Name of the type of source transaction.
• SourceTransactionTypeId: string
  Maximum Length: 30

  Value that uniquely identifies the type of source transaction.
• Subinventory: string
  Maximum Length: 10

  Name of the transaction subinventory.
• SupplierId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier who sold the genealogy object instance.
• SupplierName: string
  Read Only: true

  Maximum Length: 360

  Name of the supplier who sold the genealogy object instance.
• SupplierNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the supplier who sold the genealogy object instance.
• SupplierSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier site that is the location of the transaction.
• SupplierSiteName: string
  Title: Site

  Read Only: true

  Maximum Length: 240

  Name of the supplier site that is the location of the transaction.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure for the quantity of the transaction.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the quantity of the transaction.
• WorkCenterCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the work center that is the location of the transaction.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center that is the location of the transaction.
• WorkCenterName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Name of the work center.
• WorkOrderId: integer (int64)
  Value that uniquely identifies the work order that is the location of the transaction.
• WorkOrderNumber: string
  Maximum Length: 255

  Number that identifies the work order.
• WorkOrderOperation: string
  Maximum Length: 255

  Name of the work order operation.
• WorkOrderOperationId: integer (int64)
  Value that uniquely identifies the work order operation.

{
    "type":"object",
    "properties":{
        "Document":{
            "maxLength":"240",
            "type":"string",
            "description":"Name that identifies the document that the transaction references.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemType":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the type of source application. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the customer who bought the genealogy object instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkCenterCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the work center that is the location of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the quantity of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifier the transaction location organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrderOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerSitePartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"Number that uniquely identifies the customer party site that is the location of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure for the quantity of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "LocationCode":{
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that identifies the location of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer who bought the genealogy object instance.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerSiteNumber":{
            "title":"Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number that uniquely identifies the customer site that is the location of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the type of source transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who sold the genealogy object instance.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site that is the location of the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the work order.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of source application that is the origin of the transaction. A list of accepted values is defined in the lookup type ORA_CSE_SOURCE_SYSTEM_TYPE. Valid value is ORA_EXTERNAL.",
            "nullable":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the organization where the transaction occurs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center that is the location of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrderOperation":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the work order operation.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryLocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator of the transaction subinventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierSiteName":{
            "title":"Site",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the supplier site that is the location of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization where the transaction occurs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GenealogyTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies a genealogy transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SourceSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source application that is the origin of the transaction. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceTransactionType":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the type of source transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the location of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site that is the location of the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExternalLocation":{
            "maxLength":"240",
            "type":"string",
            "description":"Value that identifies the location of the transaction. This location can be an external address location or a value that is not validated against any location types defined in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionDate":{
            "type":"string",
            "description":"Date when the source transaction occurred.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the organization where the transaction occurs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionId":{
            "type":"number",
            "description":"Value that identifies the source transaction.",
            "nullable":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CustomerName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the customer who bought the genealogy object instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSiteParty":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the customer party site that is the location of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSitePartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer party site that is the location of the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkCenterName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationOrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the transaction location organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location of the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of transaction of the genealogy object instance.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the document type that the transaction references.",
            "nullable":false,
            "x-queryable":true
        },
        "SupplierNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the supplier who sold the genealogy object instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSiteName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the customer site that is the location of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier who sold the genealogy object instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order that is the location of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Subinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the transaction subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationOrganization":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the transaction location organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationContext":{
            "maxLength":"30",
            "type":"string",
            "description":"Description of the location of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"Name of the source application that is the origin of the transaction.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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