Jump to

• Request
• Response

POST action not supported

post

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

Request

Path Parameters

• 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: 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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

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 for ORA_INBOUND transaction lines. A customer asset identifying the replacement asset is required for ORA_OUTBOUND lines with ORA_EXTERNAL source system. Either the asset number or identifier can be provided.
• AssetNumber: string
  Number uniquely identifying the asset. Rules for ORA_INBOUND and ORA_OUTBOUND are the same as above.
• SalesOrderLineId: integer (int64)
  Value that uniquely identifies the order line. For ORA_INBOUND, it's the return material authorization line, for ORA_OUTBOUND, it's the sales order line.
• SalesOrderLineNumber: string
  Maximum Length: 120

  Number identifying the order line. For ORA_INBOUND, it's the return material authorization line number. For ORA_OUTBOUND, it's the sales order line number. For ORA_INTERNAL source system, the value defaults to the sales order line number from the order line identifier.
• SalesOrderNumber: string
  Maximum Length: 120

  Number identifying the order. For ORA_INBOUND, it's the return material authorization order number. For ORA_OUTBOUND, it's the sales order number. For ORA_INTERNAL source system, the value defaults to the sales order number from the order line identifier.
• SrcOrderFulfillmentDate: string (date-time)
  Date when the order line is fulfilled in the source system. For ORA_EXTERNAL, a past date is required. For ORA_INTERNAL, order fulfillment dates are used as the source of truth.
• TransactedAssetId: integer (int64)
  Value that uniquely identifies the transacted asset in the asset transaction. Generated by the application. Read-only.
• TransactedQuantity: number
  Quantity of the transaction for the asset. For ORA_INBOUND, it's the quantity to be replaced. For ORA_OUTBOUND, it's the replacement quantity. Quantities and units of measure default from the assets (ORA_EXTERNAL) or from order lines (ORA_INTERNAL).
• TransactedUOMCode: string
  Maximum Length: 3

  Abbreviation identifying the UOM of the transacted asset quantity. Must be convertible to the primary asset item UOM for nonserialized products. Defaults to primary asset item UOM if not provided.
• TransactionId: integer (int64)
  Value that uniquely identifies the asset transaction.
• TransactionLineType: string
  Maximum Length: 30

  Type of transaction line. Valid values are ORA_INBOUND or ORA_OUTBOUND, defined in lookup type ORA_CSE_TXN_LINE_TYPE. For ORA_REPLACE or ORA_UPGRADE, one inbound line and one outbound line are required.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset. A customer asset identifying the replaced asset is required for ORA_INBOUND transaction lines. A customer asset identifying the replacement asset is required for ORA_OUTBOUND lines with ORA_EXTERNAL source system. Either the asset number or identifier can be provided.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AssetNumber":{
            "type":"string",
            "description":"Number uniquely identifying the asset. Rules for ORA_INBOUND and ORA_OUTBOUND are the same as above.",
            "nullable":true,
            "x-queryable":false
        },
        "SalesOrderLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the order line. For ORA_INBOUND, it's the return material authorization line, for ORA_OUTBOUND, it's the sales order line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SalesOrderLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Number identifying the order line. For ORA_INBOUND, it's the return material authorization line number. For ORA_OUTBOUND, it's the sales order line number. For ORA_INTERNAL source system, the value defaults to the sales order line number from the order line identifier.",
            "nullable":true
        },
        "SalesOrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Number identifying the order. For ORA_INBOUND, it's the return material authorization order number. For ORA_OUTBOUND, it's the sales order number. For ORA_INTERNAL source system, the value defaults to the sales order number from the order line identifier.",
            "nullable":true
        },
        "SrcOrderFulfillmentDate":{
            "type":"string",
            "description":"Date when the order line is fulfilled in the source system. For ORA_EXTERNAL, a past date is required. For ORA_INTERNAL, order fulfillment dates are used as the source of truth.",
            "format":"date-time",
            "nullable":true
        },
        "TransactedAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transacted asset in the asset transaction. Generated by the application. Read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "TransactedQuantity":{
            "type":"number",
            "description":"Quantity of the transaction for the asset. For ORA_INBOUND, it's the quantity to be replaced. For ORA_OUTBOUND, it's the replacement quantity. Quantities and units of measure default from the assets (ORA_EXTERNAL) or from order lines (ORA_INTERNAL).",
            "nullable":true
        },
        "TransactedUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation identifying the UOM of the transacted asset quantity. Must be convertible to the primary asset item UOM for nonserialized products. Defaults to primary asset item UOM if not provided.",
            "nullable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionLineType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of transaction line. Valid values are ORA_INBOUND or ORA_OUTBOUND, defined in lookup type ORA_CSE_TXN_LINE_TYPE. For ORA_REPLACE or ORA_UPGRADE, one inbound line and one outbound line are required.",
            "nullable":false
        }
    }
}

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 for ORA_INBOUND transaction lines. A customer asset identifying the replacement asset is required for ORA_OUTBOUND lines with ORA_EXTERNAL source system. Either the asset number or identifier can be provided.
• AssetNumber: string
  Number uniquely identifying the asset. Rules for ORA_INBOUND and ORA_OUTBOUND are the same as above.
• BusinessProcessCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation identifying the process used when staged transactions are created for replacement or advance exchange processing. Differentiates exchange and depot repair processes. (duplicate of 12 consider removing)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SalesOrderLineId: integer (int64)
  Value that uniquely identifies the order line. For ORA_INBOUND, it's the return material authorization line, for ORA_OUTBOUND, it's the sales order line.
• SalesOrderLineNumber: string
  Maximum Length: 120

  Number identifying the order line. For ORA_INBOUND, it's the return material authorization line number. For ORA_OUTBOUND, it's the sales order line number. For ORA_INTERNAL source system, the value defaults to the sales order line number from the order line identifier.
• SalesOrderNumber: string
  Maximum Length: 120

  Number identifying the order. For ORA_INBOUND, it's the return material authorization order number. For ORA_OUTBOUND, it's the sales order number. For ORA_INTERNAL source system, the value defaults to the sales order number from the order line identifier.
• SrcOrderFulfillmentDate: string (date-time)
  Date when the order line is fulfilled in the source system. For ORA_EXTERNAL, a past date is required. For ORA_INTERNAL, order fulfillment dates are used as the source of truth.
• TransactedAssetId: integer (int64)
  Value that uniquely identifies the transacted asset in the asset transaction. Generated by the application. Read-only.
• TransactedQuantity: number
  Quantity of the transaction for the asset. For ORA_INBOUND, it's the quantity to be replaced. For ORA_OUTBOUND, it's the replacement quantity. Quantities and units of measure default from the assets (ORA_EXTERNAL) or from order lines (ORA_INTERNAL).
• TransactedUOMCode: string
  Maximum Length: 3

  Abbreviation identifying the UOM of the transacted asset quantity. Must be convertible to the primary asset item UOM for nonserialized products. Defaults to primary asset item UOM if not provided.
• TransactionId: integer (int64)
  Value that uniquely identifies the asset transaction.
• TransactionLineType: string
  Maximum Length: 30

  Type of transaction line. Valid values are ORA_INBOUND or ORA_OUTBOUND, defined in lookup type ORA_CSE_TXN_LINE_TYPE. For ORA_REPLACE or ORA_UPGRADE, one inbound line and one outbound line are required.
• TransactionStatusCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation identifying the status of the transacted asset. Values are ORA_PENDING or ORA_COMPLETED. For ORA_INTERNAL, status starts as ORA_PENDING and moves to ORA_COMPLETED when the order is fulfilled. For ORA_EXTERNAL, status is directly set to ORA_COMPLETED.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset. A customer asset identifying the replaced asset is required for ORA_INBOUND transaction lines. A customer asset identifying the replacement asset is required for ORA_OUTBOUND lines with ORA_EXTERNAL source system. Either the asset number or identifier can be provided.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "type":"string",
            "description":"Number uniquely identifying the asset. Rules for ORA_INBOUND and ORA_OUTBOUND are the same as above.",
            "nullable":true,
            "x-queryable":false
        },
        "BusinessProcessCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying the process used when staged transactions are created for replacement or advance exchange processing. Differentiates exchange and depot repair processes. (duplicate of 12 consider removing)",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the order line. For ORA_INBOUND, it's the return material authorization line, for ORA_OUTBOUND, it's the sales order line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Number identifying the order line. For ORA_INBOUND, it's the return material authorization line number. For ORA_OUTBOUND, it's the sales order line number. For ORA_INTERNAL source system, the value defaults to the sales order line number from the order line identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Number identifying the order. For ORA_INBOUND, it's the return material authorization order number. For ORA_OUTBOUND, it's the sales order number. For ORA_INTERNAL source system, the value defaults to the sales order number from the order line identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "SrcOrderFulfillmentDate":{
            "type":"string",
            "description":"Date when the order line is fulfilled in the source system. For ORA_EXTERNAL, a past date is required. For ORA_INTERNAL, order fulfillment dates are used as the source of truth.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TransactedAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transacted asset in the asset transaction. Generated by the application. Read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TransactedQuantity":{
            "type":"number",
            "description":"Quantity of the transaction for the asset. For ORA_INBOUND, it's the quantity to be replaced. For ORA_OUTBOUND, it's the replacement quantity. Quantities and units of measure default from the assets (ORA_EXTERNAL) or from order lines (ORA_INTERNAL).",
            "nullable":true,
            "x-queryable":true
        },
        "TransactedUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation identifying the UOM of the transacted asset quantity. Must be convertible to the primary asset item UOM for nonserialized products. Defaults to primary asset item UOM if not provided.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionLineType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of transaction line. Valid values are ORA_INBOUND or ORA_OUTBOUND, defined in lookup type ORA_CSE_TXN_LINE_TYPE. For ORA_REPLACE or ORA_UPGRADE, one inbound line and one outbound line are required.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying the status of the transacted asset. Values are ORA_PENDING or ORA_COMPLETED. For ORA_INTERNAL, status starts as ORA_PENDING and moves to ORA_COMPLETED when the order is fulfilled. For ORA_EXTERNAL, status is directly set to ORA_COMPLETED.",
            "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"
            }
        }
    }
}

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