Create statuses

post

/fscmRestApi/resources/11.13.18.05/workOrderStatuses

Request

Header Parameters
  • 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".
  • 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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : workOrderStatuses-item-response
Type: object
Show Source
  • Title: Inactive On
    Date when the status becomes inactive and unavailable for use.
  • Links
  • 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 is predefined with the application. If false, then the customer defines the status codes. The default value is false.
  • Title: Code
    Maximum Length: 30
    Abbreviation that identifies the work order status.
  • Title: Description
    Maximum Length: 240
    Description of the work order status.
  • Read Only: true
    Value that uniquely identifies the work order status. It is a primary key that the application generates when it creates a work order status.
  • Title: Name
    Maximum Length: 120
    Name of the work order status.
  • Title: System Status
    Maximum Length: 30
    Abbreviation that identifies the predefined status of this work order.
Back to Top

Examples

This example describes how to create statuses.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/workOrderStatuses"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
    "WoStatusCode": "QUAL_HOLD",
    "WoStatusDescription": "Order on hold for quality inspection.",
    "WoStatusName": "Quality Hold",
    "WoSystemStatusCode": "ON_HOLD",
    "InactiveDate": "2019-12-25"
}

Example Response Body

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

{
    "SeededFlag": false,
    "WoStatusCode": "QUAL_HOLD",
    "WoStatusDescription": "Order on hold for quality inspection.",
    "WoStatusId": 15032,
    "WoStatusName": "Quality Hold",
    "WoSystemStatusCode": "ON_HOLD",
    "InactiveDate": "2019-12-25",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/workOrderStatuses/15032",
            "name": "workOrderStatuses",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/workOrderStatuses/15032",
            "name": "workOrderStatuses",
            "kind": "item"
        }
    ]
}
Back to Top