Jump to

• Request
• Response

Get all available to promise on hand details

get

/fscmRestApi/resources/11.13.18.05/supplyRequests/{SupplyOrderReferenceNumber}/child/supplyOrderLines/{SupplyLineId}/child/atpSupply

Request

Path Parameters

• SupplyLineId(required): integer(int64)
  Value that uniquely identifies the supply line in Oracle Supply Chain Orchestration Cloud. The application generates this value when processing a supply request.
• SupplyOrderReferenceNumber(required): string
  Number that identifies the supply request sent to Oracle Supply Chain Orchestration Cloud.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds supply tracking lines according to the primary key.
    Finder Variables:
    • SupplyTrackingLineId; integer; Value that uniquely identifies the supply tracking line.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BackToBackFlag; boolean; Contains one of the following values: Y or N. If Y, then the supply request or order is a back-to-back supply request or order. If N, then the supply request or order is not a back-to-back supply request or order. The default value is N.
  • DestinationOrganizationCode; string; Code that identifies the inventory organization in which the supply for the requested item needs to be created. This code has to be an organization code defined in Oracle Cloud applications.
  • DestinationOrganizationId; integer; Value that uniquely identifies the inventory organization in which the supply for requested item needs to be created. This attribute value has to be associated with the organization code defined in Oracle Cloud applications.
  • DestinationOrganizationName; string; Name of the inventory organization in which the supply for the requested item needs to be created. This attribute value has to be associated with the organization code defined in Oracle Cloud applications.
  • ItemId; integer; Value that uniquely identifies the item requested in the supply request.
  • ItemNumber; string; Number that identifies the item requested in the supply request.
  • ItemRevision; string; Number that identifies the revision of the item requested in the supply request.
  • Quantity; number; Quantity of the item requested in the execution document that is being tracked.
  • SupplyChangePendingFlag; boolean; Contains one of the following values: Y or N. If Y, then the supply is undergoing change. If N, then the supply is not undergoing any change. This attribute does not have a default value.
  • SupplyExceptionFlag; boolean; Contains one of the following values: Y or N. If Y, then the supply is in exception. If N, then the supply is not in exception. This attribute does not have a default value.
  • SupplyFulfilledQuantity; number; Quantity of the requested item that has been fulfilled.
  • SupplyLineId; integer; Value that uniquely identifies the supply line in Oracle Supply Chain Orchestration Cloud. The application generates this value when processing a supply request.
  • SupplyOrderHeaderId; integer; Value that uniquely identifies the supply order header in Oracle Supply Chain Orchestration Cloud. The application generates this value while processing a supply request.
  • SupplyOrderReferenceLineId; integer; Value that uniquely identifies the supply request line in the supply request sent to Oracle Supply Chain Orchestration Cloud.
  • SupplyOrderReferenceLineNumber; string; Number that identifies the supply request line in the supply request sent to Oracle Supply Chain Orchestration Cloud.
  • SupplyParentTrackingLineId; integer; Value that uniquely identifies the parent tracking line from where this tracking line has been split.
  • SupplyTrackingLineId; integer; Value that uniquely identifies the supply tracking line in Oracle Supply Chain Orchestration Cloud. The application generates this value when processing a supply request.
  • SupplyTrackingLineNumber; integer; Number that identifies the supply tracking line in Oracle Supply Chain Orchestration Cloud. The application generates this value when processing a supply request.
  • SupplyTrackingLineStatus; string; Status of the supply tracking line in Oracle Supply Chain Orchestration Cloud. Valid values include In Purchasing, Purchase Order Created, Purchase Order Closed.
  • SupplyType; string; Type of supply that is being requested by the application requesting the supply. Values include TRANSFER, BUY, MAKE. A list of accepted values is defined in the lookup type ORA_DOS_SUPPLY_ORDER_TYPE.
  • UOMCode; string; Code that identifies the unit of measure for the item in the supply request sent to Oracle Supply Chain Orchestration Cloud.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : supplyRequests-supplyOrderLines-atpSupply

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/supplyRequests-supplyOrderLines-atpSupply-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object supplyRequests-supplyOrderLines-atpSupply-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/supplyRequests-supplyOrderLines-atpSupply-item-response"
    }
}

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 : supplyRequests-supplyOrderLines-atpSupply-item-response

Type: object

Show Source

• BackToBackFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the supply request or order is a back-to-back supply request or order. If N, then the supply request or order is not a back-to-back supply request or order. The default value is N.
• DestinationOrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Code that identifies the inventory organization in which the supply for the requested item needs to be created. This code has to be an organization code defined in Oracle Cloud applications.
• DestinationOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory organization in which the supply for requested item needs to be created. This attribute value has to be associated with the organization code defined in Oracle Cloud applications.
• DestinationOrganizationName: string
  Read Only: true

  Name of the inventory organization in which the supply for the requested item needs to be created. This attribute value has to be associated with the organization code defined in Oracle Cloud applications.
• errorMessages: array Error Messages
  Title: Error Messages

  The Error Messages resource manage the messages that indicate errors or exceptions encountered during supply creation and fulfillment.
• ItemDescription: string
  Read Only: true

  Description of the item requested in the supply request.
• ItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item requested in the supply request.
• ItemNumber: string
  Read Only: true

  Number that identifies the item requested in the supply request.
• ItemRevision: string
  Read Only: true

  Maximum Length: 72

  Number that identifies the revision of the item requested in the supply request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Quantity: number
  Read Only: true

  Quantity of the item requested in the execution document that is being tracked.
• ReservationNumber: string
  Read Only: true

  Maximum Length: 120

  Number that uniquely identifies the reservation of on hand supply.
• SupplyChangePendingFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the supply is undergoing change. If N, then the supply is not undergoing any change. This attribute does not have a default value.
• SupplyExceptionFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the supply is in exception. If N, then the supply is not in exception. This attribute does not have a default value.
• SupplyFulfilledQuantity: number
  Read Only: true

  Quantity of the requested item that has been fulfilled.
• SupplyLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supply line in Oracle Supply Chain Orchestration Cloud. The application generates this value when processing a supply request.
• SupplyOrderHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supply order header in Oracle Supply Chain Orchestration Cloud. The application generates this value while processing a supply request.
• SupplyOrderReferenceLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supply request line in the supply request sent to Oracle Supply Chain Orchestration Cloud.
• SupplyOrderReferenceLineNumber: string
  Read Only: true

  Maximum Length: 20

  Number that identifies the supply request line in the supply request sent to Oracle Supply Chain Orchestration Cloud.
• SupplyParentTrackingLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the parent tracking line from where this tracking line has been split.
• SupplyTrackingLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supply tracking line in Oracle Supply Chain Orchestration Cloud. The application generates this value when processing a supply request.
• SupplyTrackingLineNumber: integer (int64)
  Read Only: true

  Number that identifies the supply tracking line in Oracle Supply Chain Orchestration Cloud. The application generates this value when processing a supply request.
• SupplyTrackingLineStatus: string
  Read Only: true

  Maximum Length: 30

  Status of the supply tracking line in Oracle Supply Chain Orchestration Cloud. Valid values include In Purchasing, Purchase Order Created, Purchase Order Closed.
• SupplyType: string
  Read Only: true

  Maximum Length: 30

  Type of supply that is being requested by the application requesting the supply. Values include TRANSFER, BUY, MAKE. A list of accepted values is defined in the lookup type ORA_DOS_SUPPLY_ORDER_TYPE.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Code that identifies the unit of measure for the item in the supply request sent to Oracle Supply Chain Orchestration Cloud.
• UOMName: string
  Read Only: true

  Name of the unit of measure for the item in the supply request.

{
    "type":"object",
    "properties":{
        "SupplyOrderHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply order header in Oracle Supply Chain Orchestration Cloud. The application generates this value while processing a supply request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReservationNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"Number that uniquely identifies the reservation of on hand supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DestinationOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization in which the supply for requested item needs to be created. This attribute value has to be associated with the organization code defined in Oracle Cloud applications.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DestinationOrganizationName":{
            "type":"string",
            "description":"Name of the inventory organization in which the supply for the requested item needs to be created. This attribute value has to be associated with the organization code defined in Oracle Cloud applications.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyFulfilledQuantity":{
            "type":"number",
            "description":"Quantity of the requested item that has been fulfilled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item requested in the supply request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "type":"string",
            "description":"Description of the item requested in the supply request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DestinationOrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Code that identifies the inventory organization in which the supply for the requested item needs to be created. This code has to be an organization code defined in Oracle Cloud applications.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyOrderReferenceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply request line in the supply request sent to Oracle Supply Chain Orchestration Cloud.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "type":"string",
            "description":"Number that identifies the item requested in the supply request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BackToBackFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the supply request or order is a back-to-back supply request or order. If N, then the supply request or order is not a back-to-back supply request or order. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyTrackingLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply tracking line in Oracle Supply Chain Orchestration Cloud. The application generates this value when processing a supply request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplyType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of supply that is being requested by the application requesting the supply. Values include TRANSFER, BUY, MAKE. A list of accepted values is defined in the lookup type ORA_DOS_SUPPLY_ORDER_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemRevision":{
            "maxLength":"72",
            "type":"string",
            "description":"Number that identifies the revision of the item requested in the supply request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Code that identifies the unit of measure for the item in the supply request sent to Oracle Supply Chain Orchestration Cloud.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyTrackingLineNumber":{
            "type":"integer",
            "description":"Number that identifies the supply tracking line in Oracle Supply Chain Orchestration Cloud. The application generates this value when processing a supply request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the item requested in the execution document that is being tracked.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyOrderReferenceLineNumber":{
            "maxLength":"20",
            "type":"string",
            "description":"Number that identifies the supply request line in the supply request sent to Oracle Supply Chain Orchestration Cloud.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyTrackingLineStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the supply tracking line in Oracle Supply Chain Orchestration Cloud. Valid values include In Purchasing, Purchase Order Created, Purchase Order Closed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyChangePendingFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the supply is undergoing change. If N, then the supply is not undergoing any change. This attribute does not have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "errorMessages":{
            "title":"Error Messages",
            "type":"array",
            "description":"The Error Messages resource manage the messages that indicate errors or exceptions encountered during supply creation and fulfillment.",
            "items":{
                "$ref":"#/components/schemas/supplyRequests-supplyOrderLines-atpSupply-errorMessages-item-response"
            }
        },
        "SupplyLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply line in Oracle Supply Chain Orchestration Cloud. The application generates this value when processing a supply request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplyParentTrackingLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent tracking line from where this tracking line has been split.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UOMName":{
            "type":"string",
            "description":"Name of the unit of measure for the item in the supply request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplyExceptionFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the supply is in exception. If N, then the supply is not in exception. This attribute does not have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Error Messages

Type: array

Title: Error Messages

The Error Messages resource manage the messages that indicate errors or exceptions encountered during supply creation and fulfillment.

Show Source

• Array of: object supplyRequests-supplyOrderLines-atpSupply-errorMessages-item-response

{
    "title":"Error Messages",
    "type":"array",
    "description":"The Error Messages resource manage the messages that indicate errors or exceptions encountered during supply creation and fulfillment.",
    "items":{
        "$ref":"#/components/schemas/supplyRequests-supplyOrderLines-atpSupply-errorMessages-item-response"
    }
}

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 : supplyRequests-supplyOrderLines-atpSupply-errorMessages-item-response

Type: object

Show Source

• links: array Links
  Title: Links

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

  Maximum Length: 30

  Name that uniquely identifies the error message registered during supply request processing.
• MessageText: string
  Read Only: true

  Maximum Length: 1200

  Text of the error message for an error that occurred at various entities like supplyRequestLines and transferSupply while processing the supply requests.
• ProcessingEntityId: string
  Read Only: true

  Maximum Length: 30

  Value that uniquely identifies the entities like supplyRequestLines and transferSupply at which the error occurred.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProcessingEntityId":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the entities like supplyRequestLines and transferSupply at which the error occurred.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageText":{
            "maxLength":"1200",
            "type":"string",
            "description":"Text of the error message for an error that occurred at various entities like supplyRequestLines and transferSupply while processing the supply requests.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageName":{
            "maxLength":"30",
            "type":"string",
            "description":"Name that uniquely identifies the error message registered during supply request processing.",
            "nullable":true,
            "readOnly":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