Jump to

• Request
• Response
• Examples

Get one operation

get

/fscmRestApi/resources/11.13.18.05/productionExceptions/{ExceptionId}/child/ImpactedOperation/{AffectedObjectId}

Request

Path Parameters

• AffectedObjectId(required): integer
  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.
• ExceptionId(required): integer(int64)
  Value that uniquely identifies the exception. It is a primary key that the application generates when it creates a exception.

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:
  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(required):
  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(required):
  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-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 one impacted operation for one production exception.

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/ExceptionId/child/ImpactedOperation/AffectedObjectId"

For example, the following command gets impacted operation 300100098612253 for production exception 300100098612251:

curl -u username:password "https://servername/manufacturingApi/resources/version/productionExceptions/300100098612251/child/ImpactedOperation/300100098612253"

Example Response Body

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

"{
    ""AffectedObjectId"" : 300100098612253,
    ""ExceptionId"" : 300100098612251,
    ""WorkOrderId"" : 300100075230590,
    ""WorkOrderNumber"" : ""1007"",
    ""ItemNumber"" : ""RC-TAB-MINI-1000"",
    ""Description"" : ""Tab Mini "",
    ""StatusCode"" : ""ORA_OPEN"",
    ""StatusDescription"" : ""Open"",
    ""SupportedEntityTypeId"" : 1002,
    ""ReportedDate"" : null,
    ""WoOperationId"" : 300100075230591,
    ""OperationSequenceNumber"" : 10,
    ""OperationName"" : ""Op10"",
    ""StandardOperationCode"" : null,
    ""StandardOperationName"" : null,
    ""OperationPlannedStartDate"" : ""2019-01-01T15:27:00-07:00"",
    ""OperationPlannedComplDate"" : ""2019-01-01T15:27:00-07:00"",
    ""WoOperationOrder"" : null,
    ""ObjectVersionNumber"" : 1
}"

Back to Top