Jump to

• Request
• Response
• Examples

Get all exceptions

get

/fscmRestApi/resources/11.13.18.05/productionExceptions

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: Find production exceptions using the Id of the production exception as the primary key.
    Finder Variables:
    • ExceptionId; integer; Primary key that uniquely identifies the production exception. Manufacturing generates this primary key when it creates a production exception. This attribute is required.
  • findByOpId: Find production exceptions using the Id of the work order operation as the primary key.
    Finder Variables:
    • bindOpId; integer; Primary key that uniquely identifies the work order operation. Manufacturing generates this primary key when it creates a work order operation. This attribute is required.
  • findByProjectNumberTaskNumber: Find work order operations and dispatch statuses according to the project and task number. This finder is associated with a feature that requires opt in.
    Finder Variables:
    • ProjectNumber; string; Number that identifies the project associated with the work order. This attribute is associated with a feature that requires opt in.
    • TaskNumber; string; Number that identifies the task associated with the work order. This attribute is associated with a feature that requires opt in.
  • findByWoId: Find production exceptions using the Id of the work order as the primary key.
    Finder Variables:
    • bindWoId; integer; Primary key that uniquely identifies the work order. Manufacturing generates this primary key when it creates a work order. This attribute is required.
• 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:
  

  • ExceptionDescription; string; Description of the exception.
  • ExceptionId; integer; Value that uniquely identifies the exception. It is a primary key that the application generates when it creates a exception.
  • ExceptionNumber; string; Number that identifies the exception.
  • ExceptionType; string; Value that indicates the type of the exception.
  • ExpectedDowntimeInMinutes; integer; Value of the expected downtime for the production activity as a result of the exception specified in minutes.
  • ExpectedResolutionDate; string; Date when the exception is expected to be resolved.
  • InventoryItemId; number; Value that uniquely identifies the item for an exception of type component. It is a primary key that the application generates when it creates an item.
  • ItemDescription; string; Description of the item for an exception of type component.
  • ItemNumber; string; Value that identifies the item for an exception of type component.
  • ObjectVersionNumber; integer; Object version number of the exception.
  • OpenImpactedOperationCount; number; Number of work order operations impacted by the exception.
  • OrganizationId; integer; Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization.
  • ReportedBy; string; Name of the user who reported the exception.
  • ReportedDate; string; Date when the exception was reported.
  • ResourceCode; string; Value that identifies the resource for an exception of type resource.
  • ResourceId; number; Value that identifies the resource for an exception of type resource. It is a primary key that the application generates when it creates a resource.
  • ResourceInstanceCode; string; Abbreviation that identifies the resource instance.
  • ResourceInstanceId; number; Value that uniquely identifies the resource instance. It is a primary key that the application generates when it creates a resource instance.
  • ResourceInstanceName; string; Name of the resource instance.
  • ResourceName; string; Name of the resource for an exception of type resource.
  • ResourceType; string; Type of production resource. Values include Labor or Equipment.
  • SeverityCode; string; Abbreviation that identifies the severity of the exception.
  • SeverityDescription; string; Description of the severity of the exception.
  • SeverityOrder; string; Value that identifies the order of severity of the exception.
  • SupportedEntityTypeId; integer; Number that identifies the exception type. It is the primary key.
  • WoExceptionStatus; string; Status of the production exception.
  • WoOperationId; integer; Value that identifies the primary impacted work order operation of the exception. It is a primary key that the application generates when it creates a work order operation.
  • WorkAreaCode; string; Value that identifies the work area for an exception of type work area.
  • WorkAreaDescription; string; Description of the work area for an exception of type work area.
  • WorkAreaId; number; Value that identifies the work area for an exception of type work area. It is a primary key that the application generates when it creates a work area.
  • WorkAreaName; string; Name of the work area for an exception of type work area.
  • WorkCenterCode; string; Value that identifies the work center for an exception of type work center.
  • WorkCenterDescription; string; Description of the work center for an exception of type work center.
  • WorkCenterId; integer; Value that identifies the work center for an exception of type work center. It is a primary key that the application generates when it creates a work center.
  • WorkCenterName; string; Name of the work center for an exception of type work center.
  • WorkOrderId; integer; Value that identifies the primary impacted work order of the exception. It is a primary key that the application generates when it creates a work order.
  • WorkflowStatusCode; string; Abbreviation that identifies the status of the exception.
  • WorkflowStatusId; integer; Value that uniquely identifies the status of the exception.
  • WorkflowStatusMeaning; string; Meaning of the status of the exception.
• 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 : productionExceptions

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object productionExceptions-item-response

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

Type: object

Show Source

• ExceptionDescription: string
  Read Only: true

  Maximum Length: 4000

  Description of the exception.
• ExceptionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the exception. It is a primary key that the application generates when it creates a exception.
• ExceptionNumber: string
  Read Only: true

  Maximum Length: 100

  Number that identifies the exception.
• ExceptionType: string
  Read Only: true

  Maximum Length: 400

  Value that indicates the type of the exception.
• ExpectedDowntimeInMinutes: integer (int64)
  Read Only: true

  Value of the expected downtime for the production activity as a result of the exception specified in minutes.
• ExpectedResolutionDate: string (date-time)
  Read Only: true

  Date when the exception is expected to be resolved.
• ImpactedOperation: array Impacted Operations
  Title: Impacted Operations

  The Impacted Operations resource manages the work order operations that an exception impacts.
• InventoryItemId: number
  Read Only: true

  Value that uniquely identifies the item for an exception of type component. It is a primary key that the application generates when it creates an item.
• ItemDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the item for an exception of type component.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Value that identifies the item for an exception of type component.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Object version number of the exception.
• OpenImpactedOperationCount: number
  Read Only: true

  Number of work order operations impacted by the exception.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization.
• ReportedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who reported the exception.
• ReportedDate: string (date-time)
  Read Only: true

  Date when the exception was reported.
• ResourceCode: string
  Read Only: true

  Maximum Length: 30

  Value that identifies the resource for an exception of type resource.
• ResourceId: number
  Read Only: true

  Value that identifies the resource for an exception of type resource. It is a primary key that the application generates when it creates a resource.
• ResourceInstanceCode: string
  Read Only: true

  Maximum Length: 80

  Abbreviation that identifies the resource instance.
• ResourceInstanceId: number
  Read Only: true

  Value that uniquely identifies the resource instance. It is a primary key that the application generates when it creates a resource instance.
• ResourceInstanceName: string
  Read Only: true

  Maximum Length: 360

  Name of the resource instance.
• ResourceName: string
  Read Only: true

  Maximum Length: 120

  Name of the resource for an exception of type resource.
• ResourceType: string
  Read Only: true

  Maximum Length: 30

  Type of production resource. Values include Labor or Equipment.
• SeverityCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the severity of the exception.
• SeverityDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the severity of the exception.
• SeverityOrder: string
  Read Only: true

  Maximum Length: 80

  Value that identifies the order of severity of the exception.
• SupportedEntityTypeId: integer (int64)
  Read Only: true

  Number that identifies the exception type. It is the primary key.
• WoExceptionStatus: string
  Read Only: true

  Maximum Length: 4000

  Status of the production exception.
• WoOperationId: integer
  Value that identifies the primary impacted work order operation of the exception. It is a primary key that the application generates when it creates a work order operation.
• WorkAreaCode: string
  Read Only: true

  Maximum Length: 30

  Value that identifies the work area for an exception of type work area.
• WorkAreaDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the work area for an exception of type work area.
• WorkAreaId: number
  Read Only: true

  Value that identifies the work area for an exception of type work area. It is a primary key that the application generates when it creates a work area.
• WorkAreaName: string
  Read Only: true

  Maximum Length: 120

  Name of the work area for an exception of type work area.
• WorkCenterCode: string
  Read Only: true

  Maximum Length: 30

  Value that identifies the work center for an exception of type work center.
• WorkCenterDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the work center for an exception of type work center.
• WorkCenterId: integer (int64)
  Read Only: true

  Value that identifies the work center for an exception of type work center. It is a primary key that the application generates when it creates a work center.
• WorkCenterName: string
  Read Only: true

  Maximum Length: 120

  Name of the work center for an exception of type work center.
• WorkflowStatusCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the status of the exception.
• WorkflowStatusId: integer (int64)
  Read Only: true

  Value that uniquely identifies the status of the exception.
• WorkflowStatusMeaning: string
  Read Only: true

  Maximum Length: 200

  Meaning of the status of the exception.
• WorkOrderId: integer
  Value that identifies the primary impacted work order of the exception. It is a primary key that the application generates when it creates a work order.

{
    "type":"object",
    "properties":{
        "ExceptionType":{
            "maxLength":"400",
            "type":"string",
            "description":"Value that indicates the type of the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportedDate":{
            "type":"string",
            "description":"Date when the exception was reported.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that identifies the work center for an exception of type work center. It is a primary key that the application generates when it creates a work center.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkCenterDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work center for an exception of type work center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OpenImpactedOperationCount":{
            "type":"number",
            "description":"Number of work order operations impacted by the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the resource for an exception of type resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionNumber":{
            "maxLength":"100",
            "type":"string",
            "description":"Number that identifies the exception.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedDowntimeInMinutes":{
            "type":"integer",
            "description":"Value of the expected downtime for the production activity as a result of the exception specified in minutes.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkflowStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the status of the exception.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item for an exception of type component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceInstanceCode":{
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that identifies the resource instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Value that identifies the item for an exception of type component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number of the exception.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "WorkAreaName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work area for an exception of type work area.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SeverityOrder":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the order of severity of the exception.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupportedEntityTypeId":{
            "type":"integer",
            "description":"Number that identifies the exception type. It is the primary key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ImpactedOperation":{
            "title":"Impacted Operations",
            "type":"array",
            "description":"The Impacted Operations resource manages the work order operations that an exception impacts.",
            "items":{
                "$ref":"#/components/schemas/productionExceptions-ImpactedOperation-item-response"
            }
        },
        "SeverityDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the severity of the exception.",
            "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"
            }
        },
        "WorkAreaId":{
            "type":"number",
            "description":"Value that identifies the work area for an exception of type work area. It is a primary key that the application generates when it creates a work area.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedResolutionDate":{
            "type":"string",
            "description":"Date when the exception is expected to be resolved.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who reported the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the work center for an exception of type work center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the resource for an exception of type resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkAreaDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work area for an exception of type work area.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkflowStatusMeaning":{
            "maxLength":"200",
            "type":"string",
            "description":"Meaning of the status of the exception.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work center for an exception of type work center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"number",
            "description":"Value that uniquely identifies the item for an exception of type component. It is a primary key that the application generates when it creates an item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionDescription":{
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of production resource. Values include Labor or Equipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceInstanceName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the resource instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the exception. It is a primary key that the application generates when it creates a exception.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkAreaCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the work area for an exception of type work area.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"number",
            "description":"Value that identifies the resource for an exception of type resource. It is a primary key that the application generates when it creates a resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that identifies the primary impacted work order of the exception. It is a primary key that the application generates when it creates a work order.",
            "nullable":true,
            "x-queryable":true
        },
        "SeverityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the severity of the exception.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WoExceptionStatus":{
            "maxLength":"4000",
            "type":"string",
            "description":"Status of the production exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkflowStatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the status of the exception.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WoOperationId":{
            "type":"integer",
            "description":"Value that identifies the primary impacted work order operation of the exception. It is a primary key that the application generates when it creates a work order operation.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceInstanceId":{
            "type":"number",
            "description":"Value that uniquely identifies the resource instance. It is a primary key that the application generates when it creates a resource instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Impacted Operations

Type: array

Title: Impacted Operations

The Impacted Operations resource manages the work order operations that an exception impacts.

Show Source

• Array of: object productionExceptions-ImpactedOperation-item-response

{
    "title":"Impacted Operations",
    "type":"array",
    "description":"The Impacted Operations resource manages the work order operations that an exception impacts.",
    "items":{
        "$ref":"#/components/schemas/productionExceptions-ImpactedOperation-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 : productionExceptions-ImpactedOperation-item-response

Type: object

Show Source

• AffectedObjectId: integer
  Read Only: true

  Value that identifies the impacted work order operation of the exception. It is a primary key that the application generates when a work order operation is added as an impacted operation to the exception.
• Description: string
  Read Only: true

  Maximum Length: 240

  Description of the work order item that is impacted.
• ExceptionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the exception. It is a primary key that the application generates when it creates a exception.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Value of the work order item that is impacted.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Object version number of the work order operation that is impacted.
• OperationName: string
  Read Only: true

  Maximum Length: 120

  Name of the impacted work order operation.
• OperationPlannedComplDate: string (date-time)
  Read Only: true

  Date when the impacted work order operation is expected to finish.
• OperationPlannedStartDate: string (date-time)
  Read Only: true

  Date when the impacted work order operation is expected to start.
• OperationSequenceNumber: number
  Read Only: true

  Sequence number of the impacted operation in the work order.
• ProjectId: integer (int64)
  Read Only: true

  Value that uniquely identifies the project associated with the work order. This attribute is associated with a feature that requires opt in.
• ProjectNumber: string
  Title: Project Number

  Read Only: true

  Maximum Length: 25

  Number that identifies the project associated with the work order. This attribute is associated with a feature that requires opt in.
• ReportedDate: string (date-time)
  Read Only: true

  Date when the application reported the impacted work order operation.
• StandardOperationCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation of the work order operation that is impacted.
• StandardOperationName: string
  Read Only: true

  Maximum Length: 120

  Name of the work order operation that is impacted.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the status of the operation of the impacted work order.
• StatusDescription: string
  Read Only: true

  Maximum Length: 80

  Description of the status of the operation of the impacted work order.
• SupportedEntityTypeId: integer (int64)
  Read Only: true

  Value that identifies the exception type. It is the primary key.
• TaskId: integer (int64)
  Read Only: true

  Value that uniquely identifies the task associated with the work order. This attribute is associated with a feature that requires opt in.
• TaskNumber: string
  Title: Task Number

  Read Only: true

  Maximum Length: 100

  Number that identifies the task associated with the work order. This attribute is associated with a feature that requires opt in.
• WoOperationId: integer (int64)
  Read Only: true

  Value that identifies the work order operation that is impacted. It is a primary key that the application generates when it creates a work order operation.
• WoOperationOrder: number
  Read Only: true

  Number that identifies the sequence for the work order operation. This value determines the sequence to use when displaying the operations in the user interface.
• WorkOrderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the impacted work order of the exception. It is a primary key that the application generates when it creates a work order.
• WorkOrderNumber: string
  Read Only: true

  Maximum Length: 120

  Value that identifies the impacted work order of the exception.

{
    "type":"object",
    "properties":{
        "StandardOperationCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation of the work order operation that is impacted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AffectedObjectId":{
            "type":"integer",
            "description":"Value that identifies the impacted work order operation of the exception. It is a primary key that the application generates when a work order operation is added as an impacted operation to the exception.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work order item that is impacted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportedDate":{
            "type":"string",
            "description":"Date when the application reported the impacted work order operation.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task associated with the work order. This attribute is associated with a feature that requires opt in.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OperationName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the impacted work order operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"Number that identifies the project associated with the work order. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationPlannedStartDate":{
            "type":"string",
            "description":"Date when the impacted work order operation is expected to start.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"Number that identifies the task associated with the work order. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the project associated with the work order. This attribute is associated with a feature that requires opt in.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the exception. It is a primary key that the application generates when it creates a exception.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the status of the operation of the impacted work order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardOperationName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work order operation that is impacted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WoOperationOrder":{
            "type":"number",
            "description":"Number that identifies the sequence for the work order operation. This value determines the sequence to use when displaying the operations in the user interface.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationPlannedComplDate":{
            "type":"string",
            "description":"Date when the impacted work order operation is expected to finish.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Value of the work order item that is impacted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"Value that identifies the impacted work order of the exception.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the impacted work order of the exception. It is a primary key that the application generates when it creates a work order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number of the work order operation that is impacted.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "StatusDescription":{
            "maxLength":"80",
            "type":"string",
            "description":"Description of the status of the operation of the impacted work order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupportedEntityTypeId":{
            "type":"integer",
            "description":"Value that identifies the exception type. It is the primary key.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WoOperationId":{
            "type":"integer",
            "description":"Value that identifies the work order operation that is impacted. It is a primary key that the application generates when it creates a work order operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Sequence number of the impacted operation in the work order.",
            "nullable":false,
            "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

Examples

This example describes how to get all production exceptions.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/manufacturingApi/resources/version/productionExceptions"

Example Response Body

The following example includes the contents of the response body in JSON format:

"{
  ""items"" : [ {
    ""ExceptionId"" : 300100098612251,
    ""ExceptionNumber"" : ""56"",
    ""ExceptionType"" : ""Resource"",
    ""SeverityCode"" : ""ORA_CRITICAL"",
    ""SeverityOrder"" : ""1"",
    ""SeverityDescription"" : ""Critical"",
    ""ReportedBy"" : null,
    ""ReportedDate"" : null,
    ""ExpectedDowntimeInMinutes"" : null,
    ""ExpectedResolutionDate"" : null,
    ""ExceptionDescription"" : null,
    ""OrganizationId"" : 207,
    ""WorkflowStatusId"" : 101,
    ""WorkflowStatusCode"" : ""ORA_MFG_OPEN"",
    ""WorkflowStatusMeaning"" : ""Open"",
    ""SupportedEntityTypeId"" : 1003,
    ""ItemNumber"" : null,
    ""InventoryItemId"" : null,
    ""ItemDescription"" : null,
    ""ResourceId"" : 300100075229783,
    ""ResourceCode"" : ""RC-TAB-ROBOT1"",
    ""ResourceName"" : ""RC-TAB-ROBOT1"",
    ""WorkAreaId"" : null,
    ""WorkAreaCode"" : null,
    ""WorkAreaName"" : null,
    ""WorkAreaDescription"" : null,
    ""WorkCenterId"" : null,
    ""WorkCenterCode"" : null,
    ""WorkCenterName"" : null,
    ""WorkCenterDescription"" : null,
    ""OpenImpactedOperationCount"" : 1,
    ""WoExceptionStatus"" : null,
    ""ObjectVersionNumber"" : 1,
    ""WorkOrderId"" : null,
    ""WoOperationId"" : null
  }, {
...
  } ],
...
}"

Example cURL Commands

Use the following cURL commands to meet example query requirements.

Requirement	cURL Command
Query all active locators where the material status allows the application to perform an inventory transaction at the locator level. For example, query all the active locators that allow a subinventory transfer.	curl -u <username:password> -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" "https://servername/logisticsApi/resources/version/activeLocators?onlyData=true&finder=findRestrictedLocators;bindTransactionTypeId=2"
Query all active locators that an item restricts for an item across organizations that allows the application to perform an inventory transaction at the locator level. For example, query all the active locators that allow a subinventory transfer, restricted for item, and where the Inventory Item Id is 648.	curl -u username:password -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" "https://servername/logisticsApi/resources/version/activeLocators?onlyData=true&finder=findRestrictedLocators;bindTransactionTypeId=2,bindItemId=648"
Query all active stock locators.	curl -u username:password -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" "https://servername/logisticsApi/resources/version/activeLocators?onlyData=true"
Query for an active stock locator in all organizations when you know the locator, such as VC1.1.1.	curl -u username:password -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" "https://servername/logisticsApi/resources/version/activeLocators?onlyData=true&q=Locator=VC1.1.1"
Query all active stock locators when you know the organization Id, such as 207.	curl -u username:password -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" "https://servername/logisticsApi/resources/version/activeLocators?onlyData=true&q=OrganizationId=207"
Query all active locators that start with a string, such as SAN.	curl -u username:password -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" "https://servernamelogisticsApi/resources/version/activeLocators?onlyData=true&q=Locator LIKE SAN%"
Query all active locators where the description contains a string, such as Storage.	curl -u username:password -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" "https://servername/logisticsApi/resources/version/activeLocators?onlyData=true&q=Description LIKE %Storage%"
Query all locators that will be disabled on or after a date, such as 2015-12-31.	curl -u username:password -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" "https://servername/logisticsApi/resources/version/activeLocators?onlyData=true&q=DisableDate>=2015-12-31"
Query all active locators in an organization, such as W1, and that contain a value for the picking order.

Back to Top