Jump to

• Request
• Response
• Examples

Get one start or stop

get

/fscmRestApi/resources/11.13.18.05/operationStartStops/{WoOperationStartStopId}

Request

Path Parameters

• WoOperationStartStopId(required): integer(int64)
  Value that uniquely identifies the start and stop for the work order operation. You must make sure this attribute does not contain a value when you start the work order operation. The response will include value for this attribute. This attribute is required when you stop an operation.

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

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationSequenceNumber: number
  Title: Operation Sequence

  Sequence to use when performing the work order operations.
• OperationStartTime: string (date-time)
  Date and time when the work order operation starts. You must make sure OperationStartTime does not contain a value when you stop the operation.
• OperationStopTime: string (date-time)
  Date and time when the work order operation stops. You must make sure OperationStopTime does not contain a value when you start the operation.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the inventory organization that the application enabled for manufacturing.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that the application enabled for manufacturing. It is a primary key that the application generates when it creates the inventory organization.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Serial number that the work order item references.
• WoOperationId: integer (int64)
  Value that uniquely identifies the work order operation. It is a primary key that the application generates when it creates the work order operation. If you provide a value for the WoOperationId attribute, then it is not necessary to provide a value for these attributes: OrganizationId, OrganizationCode, WorkOrderNumber, WorkOrderId, and OperationSequenceNumber.
• WoOperationStartStopId: integer (int64)
  Value that uniquely identifies the start and stop for the work order operation. You must make sure this attribute does not contain a value when you start the work order operation. The response will include value for this attribute. This attribute is required when you stop an operation.
• WoProductSerialId: integer (int64)
  Value that uniquely identifies the product serial in the work order. It is a primary key that the application generates when it creates the serial number. If you are performing a serialized operation, then you must provide a value for the WoProductSerialId attribute or for the SerialNumber attribute.
• WorkOrderId: integer (int64)
  Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.
• WorkOrderNumber: string
  Maximum Length: 255

  Number that identifies the work order. This number is unique in the manufacturing organization. It is a unique number from the numbering scheme defined by these plant parameters: Work Order Prefix or Work Order Starting Number.

{
    "type":"object",
    "properties":{
        "WoProductSerialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product serial in the work order. It is a primary key that the application generates when it creates the serial number. If you are performing a serialized operation, then you must provide a value for the WoProductSerialId attribute or for the SerialNumber attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OperationStartTime":{
            "type":"string",
            "description":"Date and time when the work order operation starts. You must make sure OperationStartTime does not contain a value when you stop the operation.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the work order. This number is unique in the manufacturing organization. It is a unique number from the numbering scheme defined by these plant parameters: Work Order Prefix or Work Order Starting Number.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Serial number that the work order item references.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OperationStopTime":{
            "type":"string",
            "description":"Date and time when the work order operation stops. You must make sure OperationStopTime does not contain a value when you start the operation.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"255"
            },
            "x-queryable":true
        },
        "WoOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation. It is a primary key that the application generates when it creates the work order operation. If you provide a value for the WoOperationId attribute, then it is not necessary to provide a value for these attributes: OrganizationId, OrganizationCode, WorkOrderNumber, WorkOrderId, and OperationSequenceNumber.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "title":"Operation Sequence",
            "type":"number",
            "description":"Sequence to use when performing the work order operations.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization that the application enabled for manufacturing.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that the application enabled for manufacturing. It is a primary key that the application generates when it creates the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WoOperationStartStopId":{
            "type":"integer",
            "description":"Value that uniquely identifies the start and stop for the work order operation. You must make sure this attribute does not contain a value when you start the work order operation. The response will include value for this attribute. This attribute is required when you stop an operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to get one start and stop record for one work order operation.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/operationStartStops/WoOperationStartStopId"

For example, the following command gets operation start stop 300100114413477:

curl -u username:password "https://servername/fscmRestApi/resources/version/operationStartStops/300100114413477"

Example Response Body

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

{
  "WoOperationStartStopId" : 300100114413477,
  "OperationStartTime" : "2017-08-14T17:15:00+00:00",
  "OperationStopTime" : null,
  "OrganizationId" : 207,
  "WoOperationId" : 300100114297517,
  "OperationSequenceNumber" : 20,
  "WoProductSerialId" : null,
  "WorkOrderId" : 300100114297515,
  "WorkOrderNumber" : "M1-1109",
  "SerialNumber" : null,
  "OrganizationCode" : "M1"
}

Back to Top