Jump to

• Request
• Response

Get one maintenance work order transaction record

get

/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrderTransactionHistory/{TransactionId}

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=

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

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 : maintenanceWorkOrderTransactionHistory-item-response

Type: object

Show Source

• ActivityType: string
  Read Only: true

  Maximum Length: 80

  Indicates the activity type of the Maintenance Work Order transaction history.
• AssetDescription: string
  Read Only: true

  Maximum Length: 240

  Indicates the asset description of the Maintenance Work Order transaction history.
• AssetId: number
  Read Only: true

  Asset ID
• AssetNumber: string
  Read Only: true

  Maximum Length: 80

  Indicates the asset number of the Maintenance Work Order transaction history.
• CategoryType: string
  Read Only: true

  Maximum Length: 13

  Category Type
• Component: string
  Read Only: true

  Maximum Length: 300

  Indicates the component number of the Maintenance Work Order transaction history.
• ComponentItemId: number
  Read Only: true

  Component Item ID
• ComponentSerialNumber: string
  Read Only: true

  Maximum Length: 4000

  Indicates the component serial number of the Maintenance Work Order transaction history.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Created By
• CreationDate: string (date-time)
  Read Only: true

  Creation Date
• InventoryItemId: integer (int64)
  Read Only: true

  Inventory Item ID
• InventoryTransactionReference: number
  Read Only: true

  Indicates the inventory transaction reference of the Maintenance Work Order transaction history.
• ItemDescription: string
  Read Only: true

  Maximum Length: 240

  Indicates the item description of the Maintenance Work Order transaction history.
• ItemRevision: string
  Read Only: true

  Maximum Length: 18

  Indicates the item revision of the Maintenance Work Order transaction history.
• ItemSerialNumber: string
  Read Only: true

  Maximum Length: 80

  Indicates the item serial number of the Maintenance Work Order transaction history.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last Updated By
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last Update Login
• links: array Links
  Title: Links

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

  Maximum Length: 4000

  Indicates the location code of the Maintenance Work Order transaction history.
• LotNumber: string
  Read Only: true

  Maximum Length: 4000

  Indicates the lot number of the Maintenance Work Order transaction history.
• LPN: string
  Read Only: true

  Maximum Length: 80

  License Plate Number
• MultipleComponentSerialFlag: boolean
  Read Only: true

  Maximum Length: 1

  Multiple Component Serial Option
• MultipleItemSerialFlag: boolean
  Read Only: true

  Maximum Length: 1

  Multiple Item Serial Option
• MultipleLotFlag: boolean
  Read Only: true

  Maximum Length: 1

  Multiple Component Lot Option
• OperationSequenceNumber: number
  Read Only: true

  Indicates the operation sequence number of the Maintenance Work Order transaction history.
• OperationTransactionReference: number
  Read Only: true

  Indicates the operation transaction reference of the Maintenance Work Order transaction history.
• OperationType: string
  Read Only: true

  Maximum Length: 80

  Indicates the operation type of the maintenance work order transaction history.
• OperationTypeCode: string
  Read Only: true

  Maximum Length: 30

  Operation Type Code
• OrganizationId: integer (int64)
  Read Only: true

  Organization Id
• ParentTransactionReference: number
  Read Only: true

  Parent Transaction Reference
• ProductItemNumber: string
  Read Only: true

  Maximum Length: 300

  Indicates the product item number of the Maintenance Work Order transaction history.
• ProjectId: integer (int64)
  Read Only: true

  Project Id
• ProjectNumber: string
  Read Only: true

  Maximum Length: 25

  Indicates the project number of the Maintenance Work Order transaction history.
• PurchaseOrderline: number
  Read Only: true

  Indicates the purchase order line of the Maintenance Work Order transaction history.
• PurchaseOrderNumber: string
  Read Only: true

  Maximum Length: 30

  Indicates the purchase order number of the Maintenance Work Order transaction history.
• Quantity: number
  Read Only: true

  Quantity
• ReceiptNumber: string
  Read Only: true

  Maximum Length: 30

  Indicates the receipt number of the Maintenance Work Order transaction history.
• ReceivingTransactionReference: number
  Read Only: true

  Indicates the receiving transaction of the Maintenance Work Order transaction history.
• ResourceInstance: string
  Read Only: true

  Maximum Length: 360

  Indicates the resource instance of the Maintenance Work Order transaction history.
• ResourceName: string
  Read Only: true

  Maximum Length: 120

  Indicates the resource name of the Maintenance Work Order transaction history.
• ResourceTransactionReference: number
  Read Only: true

  Indicates the resources transaction of the Maintenance Work Order transaction history.
• SecondaryQuantity: number
  Read Only: true

  Indicates the secondary quantity associated with the maintenance work order transaction record.
• SecondaryUnitOfMeasure: string
  Read Only: true

  Maximum Length: 100

  Specifies the subinventory to which items were returned.
• SecondaryUOMCode: string
  Read Only: true

  Maximum Length: 3

  Secondary UOM Code
• SubInventory: string
  Read Only: true

  Maximum Length: 18

  Indicates the subinventory of the maintenance work order transaction history.
• SubInventoryName: string
  Read Only: true

  Maximum Length: 18

  Subinventory Name
• TaskId: integer (int64)
  Read Only: true

  Task Id
• TaskNumber: string
  Read Only: true

  Maximum Length: 100

  Indicates the task number of the Maintenance Work Order transaction history.
• TransactionDate: string (date-time)
  Read Only: true

  Indicates the transaction date of the Maintenance Work Order transaction history.
• TransactionId: integer (int64)
  Read Only: true

  Transaction ID
• TransactionNote: string
  Read Only: true

  Maximum Length: 4000

  Transaction Note
• TransactionType: string
  Read Only: true

  Maximum Length: 120

  Indicates the transaction type of the Maintenance Work Order transaction history.
• TransactionTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  Transaction Type Meaning
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 25

  Specifies the unit of measure associated with the transaction record.
• UseCommonInventoryFlag: boolean
  Read Only: true

  Maximum Length: 80

  Indicates the use common inventory flag of the Maintenance Work Order transaction history.
• WorkOrderId: integer
  Read Only: true

  Work Order ID
• WorkOrderNumber: string
  Read Only: true

  Maximum Length: 120

  Indicates the work order number of the Maintenance Work Order transaction history.

{
    "type":"object",
    "properties":{
        "ActivityType":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates the activity type of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the asset description of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"number",
            "description":"Asset ID",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates the asset number of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryType":{
            "maxLength":13,
            "type":"string",
            "description":"Category Type",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Component":{
            "maxLength":300,
            "type":"string",
            "description":"Indicates the component number of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentItemId":{
            "type":"number",
            "description":"Component Item ID",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentSerialNumber":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates the component serial number of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Created By",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Inventory Item ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryTransactionReference":{
            "type":"number",
            "description":"Indicates the inventory transaction reference of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the item description of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemRevision":{
            "maxLength":18,
            "type":"string",
            "description":"Indicates the item revision of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates the item serial number of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LPN":{
            "maxLength":80,
            "type":"string",
            "description":"License Plate Number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last Update Login",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last Updated By",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocatorCode":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates the location code of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates the lot number of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MultipleComponentSerialFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Multiple Component Serial Option",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MultipleItemSerialFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Multiple Item Serial Option",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MultipleLotFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Multiple Component Lot Option",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Indicates the operation sequence number of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationTransactionReference":{
            "type":"number",
            "description":"Indicates the operation transaction reference of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationType":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates the operation type of the maintenance work order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Operation Type Code",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Organization Id",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentTransactionReference":{
            "type":"number",
            "description":"Parent Transaction Reference",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Indicates the product item number of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectId":{
            "type":"integer",
            "description":"Project Id",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectNumber":{
            "maxLength":25,
            "type":"string",
            "description":"Indicates the project number of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseOrderNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the purchase order number of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseOrderline":{
            "type":"number",
            "description":"Indicates the purchase order line of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the receipt number of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivingTransactionReference":{
            "type":"number",
            "description":"Indicates the receiving transaction of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceInstance":{
            "maxLength":360,
            "type":"string",
            "description":"Indicates the resource instance of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":120,
            "type":"string",
            "description":"Indicates the resource name of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceTransactionReference":{
            "type":"number",
            "description":"Indicates the resources transaction of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryQuantity":{
            "type":"number",
            "description":"Indicates the secondary quantity associated with the maintenance work order transaction record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Secondary UOM Code",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUnitOfMeasure":{
            "maxLength":100,
            "type":"string",
            "description":"Specifies the subinventory to which items were returned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubInventory":{
            "maxLength":18,
            "type":"string",
            "description":"Indicates the subinventory of the maintenance work order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubInventoryName":{
            "maxLength":18,
            "type":"string",
            "description":"Subinventory Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskId":{
            "type":"integer",
            "description":"Task Id",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskNumber":{
            "maxLength":100,
            "type":"string",
            "description":"Indicates the task number of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "type":"string",
            "description":"Indicates the transaction date of the Maintenance Work Order transaction history.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Transaction ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionNote":{
            "maxLength":4000,
            "type":"string",
            "description":"Transaction Note",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":120,
            "type":"string",
            "description":"Indicates the transaction type of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Transaction Type Meaning",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Specifies the unit of measure associated with the transaction record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UseCommonInventoryFlag":{
            "maxLength":80,
            "type":"boolean",
            "description":"Indicates the use common inventory flag of the Maintenance Work Order transaction history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Work Order ID",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Indicates the work order number of the Maintenance Work Order transaction history.",
            "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