Jump to

• Request
• Response

Get all workorders

get

/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrderServiceHistory

Request

Query Parameters

• 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 resources according to the primary key.
    Finder Variables:
    • WorkOrderId; integer; Value that uniquely identifies the work order.
• 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:
  

  • ActualCompletionDate; string; Date when the work order actually completes. The value of this attribute is set when the status of the work order is moved to completed.
  • ActualStartDate; string; Date when the work order actually starts. The value of this attribute is set when the first transaction is performed against the work order.
  • ClosedDate; string; Date when the work order is closed.
  • CreatedBy; string; Session login associated with the user who created the record.
  • CreationDate; string; Date when the record was created.
  • InventoryItemId; integer; Value that uniquely identifies the item that the work order asset references.
  • LastUpdateDate; string; Date when the record was most recently updated.
  • LastUpdatedBy; string; Session login associated with the user who most recently updated the record.
  • PlannedCompletionDate; string; Date when the work order is scheduled to complete. The default value is the system date.
  • PlannedStartDate; string; Date when the work order is scheduled to start. The default value is the system date.
  • ReleasedDate; string; Date when the work order is released.
  • WorkOrderDescription; string; Description of the work order. This is the text entered by the user, which briefly describes the work to be performed. This attribute is optional to create a work order.
  • WorkOrderId; integer; 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.
  • WorkOrderNumber; string; Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number.
  • WorkOrderSubTypeCode; string; Abbreviation that uniquely identifies the work order subtype. The list of accepted values is defined in lookup type ORA_MNT_WO_SUB_TYPE.
  • WorkOrderTypeCode; string; Abbreviation that uniquely identifies the work order type. Valid values include CORRECTIVE or PREVENTIVE. A list of accepted values is defined in the lookup type ORA_MNT_WO_TYPE.
• 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: 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 : maintenanceWorkOrderServiceHistory

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/maintenanceWorkOrderServiceHistory-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Maintenance",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object maintenanceWorkOrderServiceHistory-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/maintenanceWorkOrderServiceHistory-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 : maintenanceWorkOrderServiceHistory-item-response

Type: object

Show Source

• ActualCompletionDate: string (date-time)
  Title: Actual Completion Date

  Read Only: true

  Date when the work order actually completes. The value of this attribute is set when the status of the work order is moved to completed.
• ActualStartDate: string (date-time)
  Title: Actual Start Date

  Read Only: true

  Date when the work order actually starts. The value of this attribute is set when the first transaction is performed against the work order.
• ClosedDate: string (date-time)
  Title: Closed Date

  Read Only: true

  Date when the work order is closed.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Session login associated with the user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date when the record was created.
• InventoryItemId: integer (int64)
  Title: Item

  Read Only: true

  Value that uniquely identifies the item that the work order asset references.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the record was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Session login associated with the user who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlannedCompletionDate: string (date-time)
  Title: Completion Date

  Read Only: true

  Date when the work order is scheduled to complete. The default value is the system date.
• PlannedStartDate: string (date-time)
  Title: Start Date

  Read Only: true

  Date when the work order is scheduled to start. The default value is the system date.
• ReleasedDate: string (date-time)
  Title: Released Date

  Read Only: true

  Date when the work order is released.
• WorkOrderDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the work order. This is the text entered by the user, which briefly describes the work to be performed. This attribute is optional to create a work order.
• WorkOrderId: integer (int64)
  Read Only: true

  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.
• WorkOrderNumber: string
  Title: Work Order

  Read Only: true

  Maximum Length: 120

  Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number.
• WorkOrderSubTypeCode: string
  Title: Subtype

  Read Only: true

  Maximum Length: 30

  Abbreviation that uniquely identifies the work order subtype. The list of accepted values is defined in lookup type ORA_MNT_WO_SUB_TYPE.
• WorkOrderTypeCode: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Abbreviation that uniquely identifies the work order type. Valid values include CORRECTIVE or PREVENTIVE. A list of accepted values is defined in the lookup type ORA_MNT_WO_TYPE.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Session login associated with the user who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the work order. This is the text entered by the user, which briefly describes the work to be performed. This attribute is optional to create a work order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "WorkOrderSubTypeCode":{
            "title":"Subtype",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order subtype. The list of accepted values is defined in lookup type ORA_MNT_WO_SUB_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Session login associated with the user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannedCompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"Date when the work order is scheduled to complete. The default value is the system date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item",
            "type":"integer",
            "description":"Value that uniquely identifies the item that the work order asset references.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActualStartDate":{
            "title":"Actual Start Date",
            "type":"string",
            "description":"Date when the work order actually starts. The value of this attribute is set when the first transaction is performed against the work order.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannedStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the work order is scheduled to start. The default value is the system date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "title":"Work Order",
            "maxLength":120,
            "type":"string",
            "description":"Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"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.",
            "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"
            }
        },
        "ClosedDate":{
            "title":"Closed Date",
            "type":"string",
            "description":"Date when the work order is closed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order type. Valid values include CORRECTIVE or PREVENTIVE. A list of accepted values is defined in the lookup type ORA_MNT_WO_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"Date when the work order actually completes. The value of this attribute is set when the status of the work order is moved to completed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleasedDate":{
            "title":"Released Date",
            "type":"string",
            "description":"Date when the work order is released.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the record was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "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."
        }
    }
}

Links

getRepairHistory

Operation: /fscmRestApi/resources/11.13.18.05/maintenanceWorkOrderServiceHistory/action/getRepairHistory

Provides similar completed or closed work orders using the work order details including the work order asset item, work order type, subtype, and condition event codes

Back to Top