Jump to

• Request
• Response
• Examples

Get one status

get

/fscmRestApi/resources/11.13.18.05/workOrders/{WorkOrderId}/child/WorkOrderStatus/{WoStatusId}

Request

Path Parameters

• WoStatusId(required): integer(int64)
  Value that uniquely identifies the work order status. It is a primary key that the application generates when it creates the work order status.
• WorkOrderId(required): integer(int64)
  Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.

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 : workOrders-WorkOrderStatus-item-response

Type: object

Show Source

• InactiveDate: string (date)
  Title: Inactive On

  Date when the status becomes inactive.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SeededFlag: boolean
  Title: Predefined

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the status code comes predefined with the application. If false, then the customer defines the status code. This attribute should not be in request payload. The default value for this attribute is false.
• WoStatusCode: string
  Title: Code

  Maximum Length: 30

  Abbreviation that identifies the work order status.
• WoStatusDescription: string
  Title: Description

  Maximum Length: 240

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

  Value that uniquely identifies the work order status. It is a primary key that the application generates when it creates the work order status.
• WoStatusName: string
  Title: Name

  Maximum Length: 120

  Name of the work order status.
• WoSystemStatusCode: string
  Title: System Status

  Maximum Length: 30

  Abbreviation that identifies the system status that the application maps to the work order status.

{
    "type":"object",
    "properties":{
        "WoStatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order status. It is a primary key that the application generates when it creates the work order status.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InactiveDate":{
            "title":"Inactive On",
            "type":"string",
            "description":"Date when the status becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "WoSystemStatusCode":{
            "title":"System Status",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the system status that the application maps to the work order status.",
            "nullable":false,
            "x-queryable":true
        },
        "WoStatusName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work order status.",
            "nullable":false,
            "x-queryable":true
        },
        "WoStatusDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work order status.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WoStatusCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the work order status.",
            "nullable":false,
            "x-queryable":true
        },
        "SeededFlag":{
            "title":"Predefined",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the status code comes predefined with the application. If false, then the customer defines the status code. This attribute should not be in request payload. The default value for this attribute is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "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 work order status.

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/workOrders/WorkOrderId/child/WorkOrderStatus/WoStatusId"

For example, the following command gets work order status 10002 for work order 1234:

curl -u username:password "https://servername/fscmRestApi/resources/version/workOrders/1234/child/WorkOrderStatus/10002"

Example Response Body

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

{
    "SeededFlag" : true,
    "WoStatusCode" : "ORA_COMPLETED",
    "WoStatusDescription" : "The work order is completed but can be transacted for item and resources.",
    "WoStatusId" : 10002,
    "WoStatusName" : "Completed",
    "WoSystemStatusCode" : "COMPLETED"
}

Back to Top