Update one supply
patch
/fscmRestApi/resources/11.13.18.05/replenishmentPlans/{PlanId}/child/PlanningSupplies/{TransactionId}
Request
Path Parameters
-
PlanId(required): integer
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
TransactionId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
Root Schema : schema
Type:
Show Source
object
-
BillSequenceId: integer
(int64)
Value that uniquely identifies the sequence in which a component is used within an operation.
-
CarrierId: integer
(int64)
Value that uniquely identifies the carrier.
-
ClusterId: integer
(int64)
Value that uniquely identifies the cluster.
-
ClusterName: string
Name of the cluster.
-
Customer: string
Title:
Customer
Maximum Length:4000
Name of the customer associated with the drop ship purchase order. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer.
-
CustomerSite: string
Title:
Customer Site
Maximum Length:4000
Code associated with a specific customer ship-to location. -
CustomerSiteId: integer
(int64)
Value that uniquely identifies the customer site.
-
ExcessReductionAtSrc: number
Percentage value by which the inventory excess at the source location is reduced.
-
ExpirationDate: string
(date)
Title:
Expiration Date
Date when the existing lot associated with the supply expires. -
FirmDate: string
(date)
Title:
Firm Date
Date when supply is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm. -
FirmPlannedType: integer
(int32)
Title:
Firm Status
Value that indicates whether the order is firmed or not. Valid values are 1 or 2. If 1, then the order is firm. If 2, then the order isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS. -
FirmQuantity: number
Title:
Firm Quantity
Fixed quantity of supply. This attribute value can't be changed by planning and is only populated when the firm status is firm. -
FirmStartDate: string
(date)
Date when supply begins. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.
-
FirmStartQuantity: number
Title:
Firm Start Quantity
User-specified start quantity of a supply. This attribute value can't be changed by planning and is only populated when the firm status is firm. -
ImplementAs: integer
Title:
Implement Order Type
Value that indicates the type of order to be implemented. Valid values are 1: None, 2: Purchase requisition, 3: Work order, or 5: Internal requisition. A list of accepted values is defined in the lookup type ORA_MSC_WORKBENCH_IMPLEMENT_AS. -
ImplementDate: string
(date)
Title:
Implement Date
Date when the order is released. -
ImplementDockDate: string
(date)
Title:
Implement Dock Date
Date when the material should be on the receiving dock when the order is released. -
ImplementedQuantity: number
Title:
Implemented Quantity
Cumulative quantity that has been released to date. -
ImplementEmployeeId: integer
(int64)
-
ImplementFirm: integer
Title:
Implement Firm
Value that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO. -
ImplementJobName: string
Title:
Implement Work Order Number
Maximum Length:120
Job name of the work order to be created when the order is released. -
ImplementLocation: string
Title:
Implement Location
Maximum Length:400
Value that identifies the deliver-to location to use when the order is released. -
ImplementQuantity: number
Title:
Implement Quantity
Quantity of the order that's released. -
ImplementShipDate: string
(date)
Title:
Implement Ship Date
Date when the order is shipped. -
ImplementShipMethod: string
Maximum Length:
30
Value that indicates the shipping method to use when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ImplementShippingMethod: string
Title:
Implement Shipping Method
Maximum Length:400
Value that indicates the shipping method to use when the order is released, or is a concatenation of carrier name, method of transportation, and service level to use when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ImplementSourceOrganization: string
Title:
Implement Source Organization
Maximum Length:100
Source organization used for the order that's released. -
ImplementStatusCode: integer
Title:
Implement Status
Abbreviation that identifies the status to use when the order is released. Valid values are 1 or 3. If 1, then the order isn't released. If 3, then the order is released. -
ImplementSupplier: string
Title:
Implement Supplier
Maximum Length:360
Name of the supplier for the order that's released. -
ImplementSupplierSite: string
Title:
Implement Supplier Site
Maximum Length:300
Abbreviation that indicates the specific supplier ship-from location to use when the order is released. -
InitExcessAtSource: number
Initial excess quantity at the source location before inventory rebalancing.
-
InitShortageAtDest: number
Initial shortage quantity at the destination location before inventory rebalancing.
-
MarkForReleaseOption: string
Value that indicates the release status of the order. Valid values are 1: Marked For Release or 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute.
-
ProcessSequenceId: integer
(int64)
Value that uniquely identifies the manufacturing process that was used for the make order.
-
ReleaseStatus: integer
Title:
Release Status
Code that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS. -
ReplInvRebalanceFlag: integer
Indicates whether or not the planned order is created by inventory rebalancing.
-
RoutingSequenceId: integer
(int64)
Value that uniquely identifies the routing that was used for the make order.
-
ShipMethod: string
Maximum Length:
30
Value that indicates the shipping method used to ship the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ShippingMethod: string
Title:
Shipping Method
Maximum Length:4000
Value that indicates the shipping method used to ship the order, or is a concatenation of carrier name, method of transportation, and service level associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ShortageReductionAtDest: number
Percentage value by which the inventory shortage at the destination location is reduced.
-
SourceOrganization: string
Title:
Source Organization
Maximum Length:49
Organization that will source the order. -
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the source organization.
-
Supplier: string
Title:
Supplier
Maximum Length:4000
Name of the source supplier. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierSite: string
Title:
Supplier Site
Maximum Length:4000
Abbreviation that indicates the specific supplier location from where the item is being sourced. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
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.
Root Schema : replenishmentPlans-PlanningSupplies-item-response
Type:
Show Source
object
-
Action: string
Read Only:
true
Maximum Length:80
Value that indicates the action recommended by planning. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS. -
ActionCode: integer
Read Only:
true
Code that indicates the type of recommended change made by the planning engine to the supply or demand. Valid values are 1: Cancel, 2: Reschedule in, 3: Reschedule out, 4: Release, 5: Release reservation, 6: None, and 7: Reschedule and release reservation. A list of accepted values is defined in the lookup ORA_MSC_ACTIONS. -
ActualStartDate: string
(date)
Title:
Actual Start Date
Read Only:true
-
AssetNumber: string
Title:
Asset
Read Only:true
Maximum Length:80
Number that identifies the asset associated with a maintenance work order. -
BillSequenceId: integer
(int64)
Value that uniquely identifies the sequence in which a component is used within an operation.
-
BmtOption: integer
Title:
Buyer-Managed Transportation
Read Only:true
Contains one of the following values: 1 or 2. If 1, then the buyer is responsible for the transportation of the purchased item. If 2, then the buyer isn't responsible for the transportation of the purchased item. This attribute applies only to purchased items. -
Buyer: string
Title:
Buyer
Read Only:true
Name of the buyer associated to the item. -
BuyerManagedTransportation: string
Read Only:
true
Maximum Length:200
Contains one of the following values: Yes or No. If Yes, then the buyer is responsible for the transportation of the purchased item. If No, then the buyer isn't responsible for the transportation of the purchased item. This attribute applies only to purchased items. -
CarrierId: integer
(int64)
Value that uniquely identifies the carrier.
-
CategoryName: string
Title:
Category
Read Only:true
Maximum Length:4000
Name of the category to which the item is assigned. -
ClusterId: integer
(int64)
Value that uniquely identifies the cluster.
-
ClusterName: string
Name of the cluster.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the order. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the order. -
Customer: string
Title:
Customer
Maximum Length:4000
Name of the customer associated with the drop ship purchase order. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer.
-
CustomerSite: string
Title:
Customer Site
Maximum Length:4000
Code associated with a specific customer ship-to location. -
CustomerSiteId: integer
(int64)
Value that uniquely identifies the customer site.
-
DaysPastDue: number
Title:
Days Past Due
Read Only:true
Number of days that the supply date is in the past. -
DestinationTimeZone: string
Title:
Destination Time Zone
Read Only:true
Maximum Length:100
Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization. -
DestOrgCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the destination organization for an order. -
EarliestStartDate: string
(date)
Title:
Earliest Start Date
Read Only:true
Earliest date on which a supply can start based on the lead times of all its upstream supplies, or its planning time-fence date, or based on the constrained capacity of a resource or supplier. This date is calculated by constraint-based plans -
ExcessReductionAtSrc: number
Percentage value by which the inventory excess at the source location is reduced.
-
ExpenseDestinationTransfer: string
Read Only:
true
Maximum Length:100
Contains one of the following values: Yes or No. If Yes, then the transfer is to an expense destination. If No, then the transfer isn't to an expense destination. -
ExpirationDate: string
(date)
Title:
Expiration Date
Date when the existing lot associated with the supply expires. -
FirmDate: string
(date)
Title:
Firm Date
Date when supply is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm. -
FirmPlannedType: integer
(int32)
Title:
Firm Status
Value that indicates whether the order is firmed or not. Valid values are 1 or 2. If 1, then the order is firm. If 2, then the order isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS. -
FirmQuantity: number
Title:
Firm Quantity
Fixed quantity of supply. This attribute value can't be changed by planning and is only populated when the firm status is firm. -
FirmStartDate: string
(date)
Date when supply begins. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.
-
FirmStartQuantity: number
Title:
Firm Start Quantity
User-specified start quantity of a supply. This attribute value can't be changed by planning and is only populated when the firm status is firm. -
FirmStatus: string
Read Only:
true
Maximum Length:200
Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS. -
HoldDate: string
(date)
Title:
Hold Date
Read Only:true
Date on which the on-hand inventory lot is no longer on hold. -
ImplementAs: integer
Title:
Implement Order Type
Value that indicates the type of order to be implemented. Valid values are 1: None, 2: Purchase requisition, 3: Work order, or 5: Internal requisition. A list of accepted values is defined in the lookup type ORA_MSC_WORKBENCH_IMPLEMENT_AS. -
ImplementDate: string
(date)
Title:
Implement Date
Date when the order is released. -
ImplementDockDate: string
(date)
Title:
Implement Dock Date
Date when the material should be on the receiving dock when the order is released. -
ImplementedQuantity: number
Title:
Implemented Quantity
Cumulative quantity that has been released to date. -
ImplementEmployeeId: integer
(int64)
-
ImplementFirm: integer
Title:
Implement Firm
Value that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO. -
ImplementFirmOption: string
Read Only:
true
Maximum Length:200
Status to use when the order is released. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS. -
ImplementJobName: string
Title:
Implement Work Order Number
Maximum Length:120
Job name of the work order to be created when the order is released. -
ImplementLocation: string
Title:
Implement Location
Maximum Length:400
Value that identifies the deliver-to location to use when the order is released. -
ImplementOrderType: string
Read Only:
true
Maximum Length:4000
Value that indicates the type of order to use when the order is released. A list of accepted values is defined in the lookup type ORA_MSC_WORKBENCH_IMPLEMENT_AS. -
ImplementQuantity: number
Title:
Implement Quantity
Quantity of the order that's released. -
ImplementShipDate: string
(date)
Title:
Implement Ship Date
Date when the order is shipped. -
ImplementShipMethod: string
Maximum Length:
30
Value that indicates the shipping method to use when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ImplementShippingMethod: string
Title:
Implement Shipping Method
Maximum Length:400
Value that indicates the shipping method to use when the order is released, or is a concatenation of carrier name, method of transportation, and service level to use when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ImplementSourceOrganization: string
Title:
Implement Source Organization
Maximum Length:100
Source organization used for the order that's released. -
ImplementStatus: string
Read Only:
true
Maximum Length:200
Status of the order to use when the order is released. Valid Values are Unreleased or Released. -
ImplementStatusCode: integer
Title:
Implement Status
Abbreviation that identifies the status to use when the order is released. Valid values are 1 or 3. If 1, then the order isn't released. If 3, then the order is released. -
ImplementSupplier: string
Title:
Implement Supplier
Maximum Length:360
Name of the supplier for the order that's released. -
ImplementSupplierSite: string
Title:
Implement Supplier Site
Maximum Length:300
Abbreviation that indicates the specific supplier ship-from location to use when the order is released. -
InitExcessAtSource: number
Initial excess quantity at the source location before inventory rebalancing.
-
InitShortageAtDest: number
Initial shortage quantity at the destination location before inventory rebalancing.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
Item: string
Title:
Item
Maximum Length:300
Name of the item associated with the supply. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item that's associated with the supply. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the order was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the supply. -
LatestStartDate: string
(date)
Title:
Latest Start Date
Read Only:true
Latest date on which a supply can start. This date is computed by offsetting the lead time of the supply from its need-by date. This date is calculated by constraint-based plans. -
LineNumber: string
Title:
Line Number
Read Only:true
Maximum Length:100
Number that identifies the order line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Lot: string
Title:
Lot
Read Only:true
Maximum Length:80
Number that identifies the lot of the on-hand supply. -
MakeOrBuy: string
Read Only:
true
Maximum Length:100
Value that indicates whether the item is a manufactured item or a purchased item. Valid values include Make or Buy. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY. -
MarkForReleaseOption: string
Value that indicates the release status of the order. Valid values are 1: Marked For Release or 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute.
-
Message: string
Read Only:
true
Text of the error message, if any, encountered when creating or updating a supply. -
NeedByDate: string
(date)
Title:
Need-by Date
Read Only:true
Date when the supply quantity is needed. -
OldDockDate: string
(date)
Title:
Old Dock Date
Read Only:true
Date when the order was originally to arrive at the receiving dock. This attribute value is extracted from the source application. -
OldDueDate: string
(date)
Title:
Old Due Date
Read Only:true
Date when the order was originally due. This attribute value is extracted from the source application. -
OrderNumber: string
Title:
Order Number
Read Only:true
Maximum Length:4000
Number that identifies the order associated with the supply. -
OrderQuantity: number
Title:
Order Quantity
Read Only:true
Quantity associated with the supply. -
OrderStatus: string
Read Only:
true
Maximum Length:200
SCM Cloud transactional status of a work order, purchase order, or transfer order supplies that are referred to by the planning process. -
OrderType: integer
(int32)
Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
-
OrderTypeText: string
Title:
Order Type
Maximum Length:4000
Type of order such as on hand, purchase order, or work order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE. -
Organization: string
Title:
Organization
Maximum Length:49
Name of the organization associated with the order. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
OrganizationTimeZone: string
Title:
Organization Time Zone
Read Only:true
Maximum Length:100
Time zone associated with an organization. -
OrgCurrencyCode: string
Read Only:
true
Abbreviation that identifies the base currency of the organization. -
OriginalItemName: string
Title:
Requested Item
Read Only:true
Maximum Length:4000
Name of the requested item associated with the demand. -
OriginalNeedByDate: string
(date)
Title:
Original Need-by Date
Read Only:true
Date when the order was originally needed. This value is extracted from the source application. -
PlanId: integer
(int64)
Value that uniquely identifies the plan.
-
Planner: string
Title:
Planner
Read Only:true
Maximum Length:10
Abbreviation that identifies the planner responsible for the item. -
PlannerDescription: string
Title:
Planner Description
Read Only:true
Maximum Length:100
Description of the planner responsible for the item. -
PlanningMakeBuyCode: integer
Title:
Make or Buy
Read Only:true
Abbreviation that indicates whether the item is manufactured or purchased. Valid values are 1 or 2. If 1, then the item is a manufactured item. If 2, then the item is a purchased item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY. -
ProcessSequenceId: integer
(int64)
Value that uniquely identifies the manufacturing process that was used for the make order.
-
ReleaseErrors: string
Read Only:
true
Maximum Length:400
Errors that are generated in the release process. -
ReleaseStatus: integer
Title:
Release Status
Code that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS. -
ReleaseStatusText: string
Read Only:
true
Maximum Length:80
Value that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS. -
ReleaseTimeFenceCode: integer
Read Only:
true
Abbreviation that identifies the point in time inside which planned orders with certain criteria are automatically released as work orders or purchase orders. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES. -
ReplInvRebalanceFlag: integer
Indicates whether or not the planned order is created by inventory rebalancing.
-
RoutingSequenceId: integer
(int64)
Value that uniquely identifies the routing that was used for the make order.
-
ScheduledShipDate: string
(date)
Title:
Scheduled Ship Date
Read Only:true
Date when the order is scheduled to be shipped. -
ScheduleName: string
Title:
Schedule Name
Read Only:true
Name of the supply schedule associated with an order. -
SegmentName: string
Title:
Segment
Read Only:true
Maximum Length:120
Name of the segment used for a set of items. -
SellingPrice: number
Read Only:
true
Selling price of an item on the order line. -
ShipCalendar: string
Read Only:
true
Maximum Length:15
Shipping calendar associated with the order. -
ShipMethod: string
Maximum Length:
30
Value that indicates the shipping method used to ship the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ShippingMethod: string
Title:
Shipping Method
Maximum Length:4000
Value that indicates the shipping method used to ship the order, or is a concatenation of carrier name, method of transportation, and service level associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ShipTo: string
Title:
Ship To
Read Only:true
Maximum Length:4000
Abbreviation that identifies the specific ship-to location. -
ShortageReductionAtDest: number
Percentage value by which the inventory shortage at the destination location is reduced.
-
SimulationSetId: integer
(int64)
Value that uniquely identifies the simulation set used in the plan, if any.
-
SourceOrganization: string
Title:
Source Organization
Maximum Length:49
Organization that will source the order. -
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the source organization.
-
SourceTimeZone: string
Title:
Source Time Zone
Read Only:true
Maximum Length:100
Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization. -
SourceType: integer
Value that identifies the type of planned order to be created. Valid values are 1, 2, or 3. If 1, then a planned make order is created. If 2, then a planned buy order is created. If 3, then a planned transfer order is created.
-
Subinventory: string
Title:
Subinventory
Read Only:true
Maximum Length:40
Subinventory code associated with the supply. -
SuggestedDockDate: string
(date)
Title:
Suggested Dock Date
Read Only:true
Date when the order is recommended to arrive at the receiving dock. -
SuggestedDueDate: string
(date)
Title:
Suggested Due Date
Read Only:true
Date when a supply is expected to be completed. -
SuggestedOrderDate: string
(date)
Title:
Suggested Order Date
Read Only:true
Date when an order is recommended to be placed. -
SuggestedShipDate: string
(date)
Title:
Suggested Ship Date
Read Only:true
Date when the order is recommended to be shipped. -
SuggestedStartDate: string
(date)
Title:
Suggested Start Date
Read Only:true
Date when work on the order is recommended to begin. -
Supplier: string
Title:
Supplier
Maximum Length:4000
Name of the source supplier. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierSite: string
Title:
Supplier Site
Maximum Length:4000
Abbreviation that indicates the specific supplier location from where the item is being sourced. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
TransactionId: integer
(int64)
Value that uniquely identifies the supply transaction. This value is internally generated by the application.
-
TransitLeadTime: number
Title:
Transit Lead Time
Read Only:true
Number of days that the supply is in transit between two locations. -
UOM: string
Read Only:
true
Maximum Length:200
Name of the unit of measure associated with the order quantity. -
UOMCode: string
Title:
UOM
Read Only:true
Abbreviation that identifies the unit of measure associated with the order quantity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.