Jump to

• Request
• Response

PATCH action not supported

patch

/fscmRestApi/resources/11.13.18.05/customerAssetTransactions/{TransactionId}/child/TransactedCustomerAsset/{TransactedAssetId}

Request

Path Parameters

• TransactedAssetId(required): integer(int64)
  Value that uniquely identifies transacted asset in the asset transaction. It is a value that the application generates when it creates a transaction. This attribute is read-only.
• TransactionId(required): integer(int64)
  Value that uniquely identifies the asset transaction. It is a value that the application generates when it creates a transaction. This attribute is read-only.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssetId: integer (int64)
  Value that uniquely identifies the asset. A customer asset identifying the replaced asset is required if the transaction line type is ORA_INBOUND. A customer asset identifying the replacement asset is required if the transaction line type is ORA_OUTBOUND and the source system type is ORA_EXTERNAL. You can provide either the asset number or the asset identifier.
• AssetNumber: string
  Number that uniquely identifies the asset. A customer asset identifying the replaced asset is required if the transaction line type is ORA_INBOUND. A customer asset identifying the replacement asset is required if the transaction line type is ORA_OUTBOUND and the source system type is ORA_EXTERNAL. You can provide either the asset number or the asset identifier.
• SalesOrderLineId: integer (int64)
  Value that uniquely identifies the order line. It is the return material authorization line for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order line for the replacement asset if the transaction line type is ORA_OUTBOUND.
• SalesOrderLineNumber: string
  Maximum Length: 120

  Number that identifies the order line. It is the return material authorization line number for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order line number for the replacement asset if the transaction line type is ORA_OUTBOUND. If the source system type is ORA_INTERNAL, the value provided is ignored and the value defaults to the sales order line number from the order line identifier for the transaction.
• SalesOrderNumber: string
  Maximum Length: 120

  Number that identifies the order. It is the return material authorization order number for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order number for the replacement asset if the transaction line type is ORA_OUTBOUND. If the source system type is ORA_INTERNAL, the value provided is ignored and the value defaults to the sales order number from the order line identifier for the transaction.
• SrcOrderFulfillmentDate: string (date-time)
  Date when the order line is fulfilled in the source system. If the source system type is ORA_EXTERNAL, a value is required, only a past date can be provided. When the source system type is ORA_INTERNAL, the fulfillment dates of the orders are used as the source of truth.
• TransactedAssetId: integer (int64)
  Value that uniquely identifies transacted asset in the asset transaction. It is a value that the application generates when it creates a transaction. This attribute is read-only.
• TransactedQuantity: number
  Quantity of transaction for the asset. It is the quantity to be replaced when the transaction line type is ORA_INBOUND. It is the replacement quantity when the transaction line type is ORA_OUTBOUND. If the source system type is ORA_EXTERNAL, quantities and unit of measures for the transaction are defaulted from the assets. If the source system is ORA_INTERNAL, quantities and unit of measures for the transaction are defaulted from the order lines.
• TransactedUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure of the transacted asset quantity. It must be convertible to the primary asset item unit of measure for non-serialized products. If it is not provided, it is defaulted to the primary asset item unit of measure.
• TransactionId: integer (int64)
  Value that uniquely identifies the asset transaction. It is a value that the application generates when it creates a transaction. This attribute is read-only.
• TransactionLineType: string
  Maximum Length: 30

  Type of transaction line. Valid values are ORA_INBOUND or ORA_OUTBOUND, which are defined in the lookup type ORA_CSE_TXN_LINE_TYPE. It is required to provide one transaction line of ORA_INBOUND type and one line of ORA_OUTBOUND type when the transaction type is ORA_REPLACE or ORA_UPGRADE.

{
    "type":"object",
    "properties":{
        "SalesOrderNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"Number that identifies the order. It is the return material authorization order number for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order number for the replacement asset if the transaction line type is ORA_OUTBOUND. If the source system type is ORA_INTERNAL, the value provided is ignored and the value defaults to the sales order number from the order line identifier for the transaction.",
            "nullable":true
        },
        "TransactionLineType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of transaction line. Valid values are ORA_INBOUND or ORA_OUTBOUND, which are defined in the lookup type ORA_CSE_TXN_LINE_TYPE. It is required to provide one transaction line of ORA_INBOUND type and one line of ORA_OUTBOUND type when the transaction type is  ORA_REPLACE or ORA_UPGRADE.",
            "nullable":false
        },
        "TransactedAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies transacted asset in the asset transaction. It is a value that the application generates when it creates a transaction. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "TransactedQuantity":{
            "type":"number",
            "description":"Quantity of transaction for the asset. It is the quantity to be replaced when the transaction line type is ORA_INBOUND. It is the replacement quantity when the transaction line type is ORA_OUTBOUND. If the source system type is ORA_EXTERNAL, quantities and unit of measures for the transaction are defaulted from the assets. If the source system is ORA_INTERNAL, quantities and unit of measures for the transaction are defaulted from the order lines.",
            "nullable":true
        },
        "SalesOrderLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the order line. It is the return material authorization line for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order line for the replacement asset if the transaction line type is ORA_OUTBOUND.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SalesOrderLineNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"Number that identifies the order line. It is the return material authorization line number for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order line number for the replacement asset if the transaction line type is ORA_OUTBOUND. If the source system type is ORA_INTERNAL, the value provided is ignored and the value defaults to the sales order line number from the order line identifier for the transaction.",
            "nullable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset. A customer asset identifying the replaced asset is required if the transaction line type is ORA_INBOUND. A customer asset identifying the replacement asset is required if the transaction line type is ORA_OUTBOUND and the source system type is ORA_EXTERNAL. You can provide either the asset number or the asset identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssetNumber":{
            "type":"string",
            "description":"Number that uniquely identifies the asset. A customer asset identifying the replaced asset is required if the transaction line type is ORA_INBOUND. A customer asset identifying the replacement asset is required if the transaction line type is ORA_OUTBOUND and the source system type is ORA_EXTERNAL. You can provide either the asset number or the asset identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcOrderFulfillmentDate":{
            "type":"string",
            "description":"Date when the order line is fulfilled in the source system. If the source system type is ORA_EXTERNAL, a value is required, only a past date can be provided. When the source system type is ORA_INTERNAL, the fulfillment dates of the orders are used as the source of truth.",
            "format":"date-time",
            "nullable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset transaction. It is a value that the application generates when it creates a transaction. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TransactedUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure of the transacted asset quantity. It must be convertible to the primary asset item unit of measure for non-serialized products. If it is not provided, it is defaulted to the primary asset item unit of measure.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : customerAssetTransactions-TransactedCustomerAsset-item-response

Type: object

Show Source

• AssetId: integer (int64)
  Value that uniquely identifies the asset. A customer asset identifying the replaced asset is required if the transaction line type is ORA_INBOUND. A customer asset identifying the replacement asset is required if the transaction line type is ORA_OUTBOUND and the source system type is ORA_EXTERNAL. You can provide either the asset number or the asset identifier.
• AssetNumber: string
  Number that uniquely identifies the asset. A customer asset identifying the replaced asset is required if the transaction line type is ORA_INBOUND. A customer asset identifying the replacement asset is required if the transaction line type is ORA_OUTBOUND and the source system type is ORA_EXTERNAL. You can provide either the asset number or the asset identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SalesOrderLineId: integer (int64)
  Value that uniquely identifies the order line. It is the return material authorization line for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order line for the replacement asset if the transaction line type is ORA_OUTBOUND.
• SalesOrderLineNumber: string
  Maximum Length: 120

  Number that identifies the order line. It is the return material authorization line number for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order line number for the replacement asset if the transaction line type is ORA_OUTBOUND. If the source system type is ORA_INTERNAL, the value provided is ignored and the value defaults to the sales order line number from the order line identifier for the transaction.
• SalesOrderNumber: string
  Maximum Length: 120

  Number that identifies the order. It is the return material authorization order number for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order number for the replacement asset if the transaction line type is ORA_OUTBOUND. If the source system type is ORA_INTERNAL, the value provided is ignored and the value defaults to the sales order number from the order line identifier for the transaction.
• SrcOrderFulfillmentDate: string (date-time)
  Date when the order line is fulfilled in the source system. If the source system type is ORA_EXTERNAL, a value is required, only a past date can be provided. When the source system type is ORA_INTERNAL, the fulfillment dates of the orders are used as the source of truth.
• TransactedAssetId: integer (int64)
  Value that uniquely identifies transacted asset in the asset transaction. It is a value that the application generates when it creates a transaction. This attribute is read-only.
• TransactedQuantity: number
  Quantity of transaction for the asset. It is the quantity to be replaced when the transaction line type is ORA_INBOUND. It is the replacement quantity when the transaction line type is ORA_OUTBOUND. If the source system type is ORA_EXTERNAL, quantities and unit of measures for the transaction are defaulted from the assets. If the source system is ORA_INTERNAL, quantities and unit of measures for the transaction are defaulted from the order lines.
• TransactedUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure of the transacted asset quantity. It must be convertible to the primary asset item unit of measure for non-serialized products. If it is not provided, it is defaulted to the primary asset item unit of measure.
• TransactionId: integer (int64)
  Value that uniquely identifies the asset transaction. It is a value that the application generates when it creates a transaction. This attribute is read-only.
• TransactionLineType: string
  Maximum Length: 30

  Type of transaction line. Valid values are ORA_INBOUND or ORA_OUTBOUND, which are defined in the lookup type ORA_CSE_TXN_LINE_TYPE. It is required to provide one transaction line of ORA_INBOUND type and one line of ORA_OUTBOUND type when the transaction type is ORA_REPLACE or ORA_UPGRADE.
• TransactionStatusCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the status of the transacted asset. This attribute is read-only. Values are ORA_PENDING or ORA_COMPLETED. When the source system type is ORA_INTERNAL, the transaction status is initially set to ORA_PENDING. It moves to ORA_COMPLETED whenever the corresponding order is fulfilled. When the source system is ORA_EXTERNAL, the transaction status is directly set to ORA_COMPLETED since it is assumed that the orders are fulfilled in the source system.

{
    "type":"object",
    "properties":{
        "TransactionLineType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of transaction line. Valid values are ORA_INBOUND or ORA_OUTBOUND, which are defined in the lookup type ORA_CSE_TXN_LINE_TYPE. It is required to provide one transaction line of ORA_INBOUND type and one line of ORA_OUTBOUND type when the transaction type is  ORA_REPLACE or ORA_UPGRADE.",
            "nullable":false,
            "x-queryable":true
        },
        "AssetNumber":{
            "type":"string",
            "description":"Number that uniquely identifies the asset. A customer asset identifying the replaced asset is required if the transaction line type is ORA_INBOUND. A customer asset identifying the replacement asset is required if the transaction line type is ORA_OUTBOUND and the source system type is ORA_EXTERNAL. You can provide either the asset number or the asset identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcOrderFulfillmentDate":{
            "type":"string",
            "description":"Date when the order line is fulfilled in the source system. If the source system type is ORA_EXTERNAL, a value is required, only a past date can be provided. When the source system type is ORA_INTERNAL, the fulfillment dates of the orders are used as the source of truth.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset transaction. It is a value that the application generates when it creates a transaction. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactedUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure of the transacted asset quantity. It must be convertible to the primary asset item unit of measure for non-serialized products. If it is not provided, it is defaulted to the primary asset item unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"Number that identifies the order. It is the return material authorization order number for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order number for the replacement asset if the transaction line type is ORA_OUTBOUND. If the source system type is ORA_INTERNAL, the value provided is ignored and the value defaults to the sales order number from the order line identifier for the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactedAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies transacted asset in the asset transaction. It is a value that the application generates when it creates a transaction. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TransactionStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the status of the transacted asset. This attribute is read-only. Values are ORA_PENDING or ORA_COMPLETED. When the source system type is ORA_INTERNAL, the transaction status is initially set to ORA_PENDING. It moves to ORA_COMPLETED whenever the corresponding order is fulfilled. When the source system is ORA_EXTERNAL, the transaction status is directly set to ORA_COMPLETED since it is assumed that the orders are fulfilled in the source system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactedQuantity":{
            "type":"number",
            "description":"Quantity of transaction for the asset. It is the quantity to be replaced when the transaction line type is ORA_INBOUND. It is the replacement quantity when the transaction line type is ORA_OUTBOUND. If the source system type is ORA_EXTERNAL, quantities and unit of measures for the transaction are defaulted from the assets. If the source system is ORA_INTERNAL, quantities and unit of measures for the transaction are defaulted from the order lines.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the order line. It is the return material authorization line for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order line for the replacement asset if the transaction line type is ORA_OUTBOUND.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SalesOrderLineNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"Number that identifies the order line. It is the return material authorization line number for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order line number for the replacement asset if the transaction line type is ORA_OUTBOUND. If the source system type is ORA_INTERNAL, the value provided is ignored and the value defaults to the sales order line number from the order line identifier for the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset. A customer asset identifying the replaced asset is required if the transaction line type is ORA_INBOUND. A customer asset identifying the replacement asset is required if the transaction line type is ORA_OUTBOUND and the source system type is ORA_EXTERNAL. You can provide either the asset number or the asset identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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