Jump to

• Request
• Response

Get all assets

get

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

Request

Path Parameters

• 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.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the associated asset with the specified primary key.
    Finder Variables:
    • WoAssetId; integer; Unique identifier of the associated asset.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssetId; integer; 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; Value that uniquely identifies the item referenced in the work order asset. This attribute is read-only.
  • LotNumber; string; 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; 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; Identifier of the organization associated to the respective work order assets.This attribute is read-only.
  • PrimaryReasonForRepair; string; Meaning of the primary reason for the repair code. This attribute is read-only.
  • PrimaryReasonForRepairCode; string; 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; Asset quantity and is read-only. The value is derived from the respective work order asset.
  • SerialNumber; string; 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; The primary unit of measure of the item associated to the asset in context.
  • WarrantyRepairFlag; boolean; 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; 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; Value that uniquely identifies the work order to which the asset is associated. This attribute is read-only.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : maintenanceWorkOrders-WorkOrderAsset

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/maintenanceWorkOrders-WorkOrderAsset-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object maintenanceWorkOrders-WorkOrderAsset-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/maintenanceWorkOrders-WorkOrderAsset-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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