Jump to

• Request
• Response

Get all assets

get

/crmRestApi/resources/11.13.18.05/subscriptionAssets

Request

Query Parameters

• 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 the asset with the specified primary key.
    Finder Variables
    • AssetId; integer; The unique identifier of the asset used to find it.
• 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:
  

  • ActiveEndDate; string; The active end date of the asset.
  • AssetId; integer; The unique identifier of the asset.
  • AssetNumber; string; The asset number of the asset.
  • BuId; integer; The unique business unit identifier of the asset.
  • BuName; string; The business unit name of the asset.
  • CurrentLocationContext; string; The current location context of the asset.
  • CurrentLocationId; integer; The current location identifier of the asset.
  • CustomerBillingPartyId; integer; The customer billing party identifier of the asset.
  • CustomerBillingPartySiteId; integer; The customer billing party site identifier of the asset.
  • CustomerId; integer; The customer identifier of the asset.
  • CustomerSiteId; integer; The customer site identifier of the asset.
  • CustomerSitePartyId; integer; The customer site party identifier of the asset.
  • Description; string; The description of the asset.
  • InventoryItemId; integer; The inventory item identifier of the asset.
  • ItemDescription; string; The item description of the asset.
  • ItemId; integer; The item identifier of the asset.
  • ItemNumber; string; The item number of the asset.
  • ItemOrganizationId; integer; The item organization identifier of the asset.
  • ItemRevision; string; The item revision of the asset.
  • LotNumber; string; The lot number of the asset.
  • ObjectVersionNumber; integer; The object version number of the asset.
  • OrganizationCode; string; The organization code of the asset.
  • OrganizationId; integer; The organization identifier of the asset.
  • OrganizationId1; integer; The organization identifier 1 of the asset.
  • PartyId; integer; The party identifier of the asset.
  • PartyId1; integer; The party identifier 1 of the asset.
  • PartyId2; integer; The party identifier 2 of the asset.
  • PartyName; string; The party name of the asset.
  • PartyName1; string; The party name 1 of the asset.
  • PartyName2; string; The party name 2 of the asset.
  • Quantity; number; The quantity of the asset.
  • SalesOrderId; integer; The sales order identifier of the asset.
  • SalesOrderLineId; integer; The sales order line identifier of the asset.
  • SalesOrderLineNumber; string; The sales order line number of the asset.
  • SalesOrderNumber; string; The sales order number of the asset.
  • SerialNumber; string; The serial number of the asset.
  • ServiceableProductFlag; boolean; Contains one of the following values: true or false. If true, then the item is eligible to be covered in a service contract. If false, then the item isn't eligible to be covered in a service contract. The default value is false. For a list of attribute value interdependencies, see the topic Interdependent Item Attributes in the Oracle Fusion Cloud SCM: Using Product Master Data Management guide, available on the Oracle Help Center.
  • ShipmentDate; string; The shipment date of the asset.
  • SoldByBusinessUnitId; integer; The sold by business unit identifier of the asset.
  • UomCode; string; The UOM code of the asset.
• 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: 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.

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 : subscriptionAssets

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/subscriptionAssets-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object subscriptionAssets-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/subscriptionAssets-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 : subscriptionAssets-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Read Only: true

  The active end date of the asset.
• AssetId: integer
  The unique identifier of the asset.
• AssetNumber: string
  Title: Covered Level Name

  Read Only: true

  Maximum Length: 80

  The asset number of the asset.
• BuId: integer (int64)
  Read Only: true

  The unique business unit identifier of the asset.
• BuName: string
  Read Only: true

  Maximum Length: 240

  The business unit name of the asset.
• CurrentLocationContext: string
  Read Only: true

  Maximum Length: 80

  The current location context of the asset.
• CurrentLocationId: integer (int64)
  Read Only: true

  The current location identifier of the asset.
• CustomerBillingPartyId: integer (int64)
  Read Only: true

  The customer billing party identifier of the asset.
• CustomerBillingPartySiteId: integer (int64)
  Read Only: true

  The customer billing party site identifier of the asset.
• CustomerId: integer (int64)
  Read Only: true

  The customer identifier of the asset.
• CustomerSiteId: integer (int64)
  Read Only: true

  The customer site identifier of the asset.
• CustomerSitePartyId: integer (int64)
  Read Only: true

  The customer site party identifier of the asset.
• Description: string
  Read Only: true

  Maximum Length: 240

  The description of the asset.
• InventoryItemId: integer (int64)
  Read Only: true

  The inventory item identifier of the asset.
• ItemDescription: string
  Read Only: true

  Maximum Length: 240

  The item description of the asset.
• ItemId: integer (int64)
  Read Only: true

  The item identifier of the asset.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  The item number of the asset.
• ItemOrganizationId: integer (int64)
  Read Only: true

  The item organization identifier of the asset.
• ItemRevision: string
  Read Only: true

  Maximum Length: 18

  The item revision of the asset.
• links: array Links
  Title: Links

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

  Maximum Length: 80

  The lot number of the asset.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number of the asset.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18

  The organization code of the asset.
• OrganizationId: integer (int64)
  Read Only: true

  The organization identifier of the asset.
• OrganizationId1: integer (int64)
  Read Only: true

  The organization identifier 1 of the asset.
• PartyId: integer (int64)
  Read Only: true

  The party identifier of the asset.
• PartyId1: integer (int64)
  Read Only: true

  The party identifier 1 of the asset.
• PartyId2: integer (int64)
  Read Only: true

  The party identifier 2 of the asset.
• PartyName: string
  Read Only: true

  Maximum Length: 360

  The party name of the asset.
• PartyName1: string
  Read Only: true

  Maximum Length: 360

  The party name 1 of the asset.
• PartyName2: string
  Read Only: true

  Maximum Length: 360

  The party name 2 of the asset.
• Quantity: number
  Read Only: true

  The quantity of the asset.
• SalesOrderId: integer (int64)
  Read Only: true

  The sales order identifier of the asset.
• SalesOrderLineId: integer (int64)
  Read Only: true

  The sales order line identifier of the asset.
• SalesOrderLineNumber: string
  Read Only: true

  Maximum Length: 120

  The sales order line number of the asset.
• SalesOrderNumber: string
  Read Only: true

  Maximum Length: 120

  The sales order number of the asset.
• SerialNumber: string
  Title: Serial Number

  Read Only: true

  Maximum Length: 80

  The serial number of the asset.
• ServiceableProductFlag: boolean
  Title: Enable Contract Coverage

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the item is eligible to be covered in a service contract. If false, then the item isn't eligible to be covered in a service contract. The default value is false. For a list of attribute value interdependencies, see the topic Interdependent Item Attributes in the Oracle Fusion Cloud SCM: Using Product Master Data Management guide, available on the Oracle Help Center.
• ShipmentDate: string (date)
  Read Only: true

  The shipment date of the asset.
• SoldByBusinessUnitId: integer (int64)
  Read Only: true

  The sold by business unit identifier of the asset.
• UomCode: string
  Read Only: true

  Maximum Length: 3

  The UOM code of the asset.

{
    "type":"object",
    "properties":{
        "OrganizationId1":{
            "type":"integer",
            "description":"The organization identifier 1 of the asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "CurrentLocationContext":{
            "maxLength":80,
            "type":"string",
            "description":"The current location context of the asset.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ServiceableProductFlag":{
            "title":"Enable Contract Coverage",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the item is eligible to be covered in a service contract. If false, then the item isn't eligible to be covered in a service contract. The default value is false. For a list of attribute value interdependencies, see the topic Interdependent Item Attributes in the Oracle Fusion Cloud SCM: Using Product Master Data Management guide, available on the Oracle Help Center.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "PartyName":{
            "maxLength":360,
            "type":"string",
            "description":"The party name of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The organization identifier of the asset.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName2":{
            "maxLength":360,
            "type":"string",
            "description":"The party name 2 of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Covered Level Name",
            "maxLength":80,
            "type":"string",
            "description":"The asset number of the asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"The item identifier of the asset.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The item description of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "PartyName1":{
            "maxLength":360,
            "type":"string",
            "description":"The party name 1 of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SoldByBusinessUnitId":{
            "type":"integer",
            "description":"The sold by business unit identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerBillingPartyId":{
            "type":"integer",
            "description":"The customer billing party identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "CurrentLocationId":{
            "type":"integer",
            "description":"The current location identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "ItemOrganizationId":{
            "type":"integer",
            "description":"The item organization identifier of the asset.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"The item number of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the asset.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":9
            },
            "x-queryable":true
        },
        "SalesOrderId":{
            "type":"integer",
            "description":"The sales order identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderLineId":{
            "type":"integer",
            "description":"The sales order line identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The sales order line number of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"The organization code of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemRevision":{
            "maxLength":18,
            "type":"string",
            "description":"The item revision of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ActiveEndDate":{
            "type":"string",
            "description":"The active end date of the asset.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"The lot number of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CustomerSitePartyId":{
            "type":"integer",
            "description":"The customer site party identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The inventory item identifier of the asset.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the asset.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CustomerId":{
            "type":"integer",
            "description":"The customer identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "BuName":{
            "maxLength":240,
            "type":"string",
            "description":"The business unit name of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "PartyId2":{
            "type":"integer",
            "description":"The party identifier 2 of the asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId1":{
            "type":"integer",
            "description":"The party identifier 1 of the asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The sales order number of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BuId":{
            "type":"integer",
            "description":"The unique business unit identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"The serial number of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"The customer site identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The party identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "ShipmentDate":{
            "type":"string",
            "description":"The shipment date of the asset.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "UomCode":{
            "maxLength":3,
            "type":"string",
            "description":"The UOM code of the asset.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CustomerBillingPartySiteId":{
            "type":"integer",
            "description":"The customer billing party site identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "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