Jump to

• Request
• Response

Add asset routes

patch

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

Request

Path Parameters

• WoAssetId(required): integer(int64)
  Value that uniquely identifies the asset's association with the maintenance work order for the asset route. This attribute is read-only and 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: 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• RouteCompleteFlag: boolean
  Maximum Length: 1

  Indicates the completed flag for the work order asset route. This value represents the completion status of the asset.
• RouteSkippedFlag: boolean
  Maximum Length: 1

  Indicates the skipped flag for the work order asset route. This value represents the skipped status of the asset.

{
    "type":"object",
    "properties":{
        "RouteSkippedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the skipped flag for the work order asset route. This value represents the skipped status of the asset.",
            "nullable":true
        },
        "RouteCompleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the completed flag for the work order asset route. This value represents the completion status of the asset.",
            "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-RouteAssets-item-response

Type: object

Show Source

• AssetDescription: string
  Read Only: true

  Maximum Length: 240

  Number that uniquely identifies the asset route description associated to the maintenance work order.
• AssetId: integer (int64)
  Read Only: true

  Value that uniquely identifies the asset route associated with the maintenance work order. When the work order status is other than 'unreleased,' the assets in the work order cannot be updated or deleted.
• AssetNumber: string
  Read Only: true

  Maximum Length: 80

  Number that uniquely identifies the asset route associated with the maintenance work order. When the work order status is other than 'unreleased,' the assets in the work order cannot be updated or deleted.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Location: string
  Read Only: true

  Maximum Length: 255

  The location context of the asset route associated with the work order. This value represents the location of the asset associated with the work order.
• LocationType: string
  Read Only: true

  Maximum Length: 80

  The location type of the asset route associated with the work order. This value represents the current location of the asset associated with the work order.
• LocationTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  The location meaning of the asset route associated with the work order. This value represents the location meaning of the asset associated with the work order.
• RouteCompleteFlag: boolean
  Maximum Length: 1

  Indicates the completed flag for the work order asset route. This value represents the completion status of the asset.
• RouteSkippedFlag: boolean
  Maximum Length: 1

  Indicates the skipped flag for the work order asset route. This value represents the skipped status of the asset.
• SerialNumber: string
  Read Only: true

  Maximum Length: 80

  The serial number of the asset route associated with the work order. The value is conditionally referenced in the asset based on the attributes of the item associated with the work order asset.
• WoAssetId: integer (int64)
  Read Only: true

  Value that uniquely identifies the asset's association with the maintenance work order for the asset route. This attribute is read-only and generated when the asset is added to the work order.
• WorkOrderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work order to which the asset route is associated. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "RouteSkippedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the skipped flag for the work order asset route. This value represents the skipped status of the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"The serial number of the asset route associated with the work order. The value is conditionally referenced in the asset based on the attributes of the item associated with 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 route is associated. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Number that uniquely identifies the asset route description associated to the maintenance work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WoAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset's association with the maintenance work order for the asset route. This attribute is read-only and generated when the asset is added to the work order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RouteCompleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the completed flag for the work order asset route. This value represents the completion status of the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset route associated with the maintenance work order. When the work order status is other than 'unreleased,' the assets in the work order cannot be updated or deleted.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the asset route associated with the maintenance work order. When the work order status is other than 'unreleased,' the assets in the work order cannot be updated or deleted.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationType":{
            "maxLength":80,
            "type":"string",
            "description":"The location type of the asset route associated with the work order. This value represents the current location of the asset associated with the work order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The location meaning of the asset route associated with the work order. This value represents the location meaning of the asset associated with the work order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Location":{
            "maxLength":255,
            "type":"string",
            "description":"The location context of the asset route associated with the work order. This value represents the location of the asset associated with the work order.",
            "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