Jump to

• Request
• Response

Update one asset record

patch

/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrders/{WorkOrderId}/child/WorkOrderAsset/{WoAssetId}

Request

Path Parameters

• WoAssetId(required): integer(int64)
  Value that uniquely identifies the asset association to the maintenance work order . This attribute is read-only. The value is generated when the asset is added to the work order.
• WorkOrderId(required): integer(int64)
  Value that uniquely identifies the work order. This attribute is read-only. The value of this attribute is derived from the work order number when the application creates the work order.

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 associated to the maintenance work order. When the value for "AllowMultipleAssetsFlag" is True it is a multiple asset maintenance work order. For a multiple asset work order the child resource is used for managing assets associated to the work order when the work order is in unreleased status. When the work order status is other than unreleased the assets in the work order cannot be updated or deleted.
• AssetNumber: string
  Numebr that uniquely identifies the asset associated to the maintenance work order. When the value for "AllowMultipleAssetsFlag" is True it is a multiple asset maintenance work order. For a multiple asset work order the child resource is used for managing assets associated to the work order when the work order is in unreleased status. When the work order status is other than unreleased the assets in the work order cannot be updated or deleted.
• MatchToTransactionCodeFlag: boolean
  Title: Match Transaction Codes

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then only those material and resource transactions that have a matching repair transaction code in an active warranty contract are considered for creating a warranty entitlement. If false, then entitlements are created for all material and resource transactions. This attribute has a default value of false.
• PrimaryReasonForRepairCode: string
  Title: Primary Reason for Repair Code

  Maximum Length: 30

  Abbreviation that identifies the primary reason for repair of the maintenance work order asset. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Reason for repair.
• WarrantyRepairFlag: boolean
  Title: Warranty Repair

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the work order is considered for warranty entitlement creation and claim review. If false, then the work order isn't considered for warranty entitlement creation and claim review. This attribute has a default value of false.
• WoAssetId: integer (int64)
  Value that uniquely identifies the asset association to the maintenance work order . This attribute is read-only. The value is generated when the asset is added to the work order.
• WorkOrderId: integer (int64)
  Value that uniquely identifies the work order to which the asset is associated. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order to which the asset is associated. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "MatchToTransactionCodeFlag":{
            "title":"Match Transaction Codes",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then only those material and resource transactions that have a matching repair transaction code in an active warranty contract are considered for creating a warranty entitlement. If false, then entitlements are created for all material and resource transactions. This attribute has a default value of false.",
            "nullable":true
        },
        "WarrantyRepairFlag":{
            "title":"Warranty Repair",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the work order is considered for warranty entitlement creation and claim review. If false, then the work order isn't considered for warranty entitlement creation and claim review. This attribute has a default value of false.",
            "nullable":true
        },
        "WoAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset association to the maintenance work order . This attribute is read-only. The value is generated when the asset is added to the work order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PrimaryReasonForRepairCode":{
            "title":"Primary Reason for Repair Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the primary reason for repair of the maintenance work order asset. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Reason for repair.",
            "nullable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset associated to the maintenance work order.  When the value for \"AllowMultipleAssetsFlag\" is True it is a multiple asset maintenance work order. For a multiple asset work order the child resource is used for managing assets associated to the work order when the work order is in unreleased status. When the work order status is other than unreleased the assets in the work order cannot be updated or deleted.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssetNumber":{
            "type":"string",
            "description":"Numebr that uniquely identifies the asset associated to the maintenance work order.  When the value for \"AllowMultipleAssetsFlag\" is True it is a multiple asset maintenance work order. For a multiple asset work order the child resource is used for managing assets associated to the work order when the work order is in unreleased status. When the work order status is other than unreleased the assets in the work order cannot be updated or deleted.",
            "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 : maintenanceWorkOrders-WorkOrderAsset-item-response

Type: object

Show Source

• AssetId: integer (int64)
  Value that uniquely identifies the asset associated to the maintenance work order. When the value for "AllowMultipleAssetsFlag" is True it is a multiple asset maintenance work order. For a multiple asset work order the child resource is used for managing assets associated to the work order when the work order is in unreleased status. When the work order status is other than unreleased the assets in the work order cannot be updated or deleted.
• AssetNumber: string
  Numebr that uniquely identifies the asset associated to the maintenance work order. When the value for "AllowMultipleAssetsFlag" is True it is a multiple asset maintenance work order. For a multiple asset work order the child resource is used for managing assets associated to the work order when the work order is in unreleased status. When the work order status is other than unreleased the assets in the work order cannot be updated or deleted.
• ItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item referenced in the work order asset. This attribute is read-only.
• 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 associated to the work order. The value is conditionally referenced in the asset based on the attributes of the item associated to the work order asset.
• MatchToTransactionCodeFlag: boolean
  Title: Match Transaction Codes

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then only those material and resource transactions that have a matching repair transaction code in an active warranty contract are considered for creating a warranty entitlement. If false, then entitlements are created for all material and resource transactions. This attribute has a default value of false.
• OrganizationId: integer (int64)
  Identifier of the organization associated to the respective work order assets.This attribute is read-only.
• PrimaryReasonForRepair: string
  Title: Primary Reason for Repair

  Read Only: true

  Maximum Length: 240

  Meaning of the primary reason for the repair code. This attribute is read-only.
• PrimaryReasonForRepairCode: string
  Title: Primary Reason for Repair Code

  Maximum Length: 30

  Abbreviation that identifies the primary reason for repair of the maintenance work order asset. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Reason for repair.
• Quantity: number
  Read Only: true

  Asset quantity and is read-only. The value is derived from the respective work order asset.
• SerialNumber: string
  Read Only: true

  Maximum Length: 80

  The serial number of the asset associated to the work order. The value is conditionally referenced in the asset based on the attributes of the item associated to the work order asset.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  The primary unit of measure of the item associated to the asset in context.
• WarrantyRepairFlag: boolean
  Title: Warranty Repair

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the work order is considered for warranty entitlement creation and claim review. If false, then the work order isn't considered for warranty entitlement creation and claim review. This attribute has a default value of false.
• WoAssetId: integer (int64)
  Value that uniquely identifies the asset association to the maintenance work order . This attribute is read-only. The value is generated when the asset is added to the work order.
• WorkOrderId: integer (int64)
  Value that uniquely identifies the work order to which the asset is associated. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "PrimaryReasonForRepair":{
            "title":"Primary Reason for Repair",
            "maxLength":"240",
            "type":"string",
            "description":"Meaning of the primary reason for the repair code.  This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MatchToTransactionCodeFlag":{
            "title":"Match Transaction Codes",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then only those material and resource transactions that have a matching repair transaction code in an active warranty contract are considered for creating a warranty entitlement. If false, then entitlements are created for all material and resource transactions. This attribute has a default value of false.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Asset quantity and is read-only. The value is derived from the respective work order asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WoAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset association to the maintenance work order . This attribute is read-only. The value is generated when the asset is added to the work order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Identifier of the organization associated to the respective work order assets.This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryReasonForRepairCode":{
            "title":"Primary Reason for Repair Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the primary reason for repair of the maintenance work order asset. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Reason for repair.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item referenced in the work order asset. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "type":"string",
            "description":"Numebr that uniquely identifies the asset associated to the maintenance work order.  When the value for \"AllowMultipleAssetsFlag\" is True it is a multiple asset maintenance work order. For a multiple asset work order the child resource is used for managing assets associated to the work order when the work order is in unreleased status. When the work order status is other than unreleased the assets in the work order cannot be updated or deleted.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"The serial number of the asset associated to the work order. The value is conditionally referenced in the asset based on the attributes of the item associated to the work order asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order to which the asset is associated. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WarrantyRepairFlag":{
            "title":"Warranty Repair",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the work order is considered for warranty entitlement creation and claim review. If false, then the work order isn't considered for warranty entitlement creation and claim review. This attribute has a default value of false.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The primary unit of measure of the item associated to the asset in context.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset associated to the maintenance work order.  When the value for \"AllowMultipleAssetsFlag\" is True it is a multiple asset maintenance work order. For a multiple asset work order the child resource is used for managing assets associated to the work order when the work order is in unreleased status. When the work order status is other than unreleased the assets in the work order cannot be updated or deleted.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"The lot number of the asset associated to the work order. The value is conditionally referenced in the asset based on the attributes of the item associated to the work order asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top