Jump to

• Request
• Response
• Examples

Change status

post

/fscmRestApi/resources/11.13.18.05/newItemRequests/action/changeStatus

Changes the status of the new item request.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• comments: string
  Comments from the user.
• nirId: number
  Value that uniquely identifies the new item request.
• nirNumber: string
  Number that uniquely identifies the new item request.
• orgCode: string
  Abbreviation that identifies the organization of the new item request.
• orgId: number
  Value that uniquely identifies the organization of the new item request.
• toStatusCode: number
  Abbreviation that identifies the status of the new item request.
• toStatusName: string
  Status of the new item request.

{
    "type":"object",
    "properties":{
        "toStatusCode":{
            "type":"number",
            "description":"Abbreviation that identifies the status of the new item request.",
            "nullable":true
        },
        "comments":{
            "type":"string",
            "description":"Comments from the user.",
            "nullable":true
        },
        "orgCode":{
            "type":"string",
            "description":"Abbreviation that identifies the organization of the new item request.",
            "nullable":true
        },
        "nirNumber":{
            "type":"string",
            "description":"Number that uniquely identifies the new item request.",
            "nullable":true
        },
        "toStatusName":{
            "type":"string",
            "description":"Status of the new item request.",
            "nullable":true
        },
        "nirId":{
            "type":"number",
            "description":"Value that uniquely identifies the new item request.",
            "nullable":true
        },
        "orgId":{
            "type":"number",
            "description":"Value that uniquely identifies the organization of the new item request.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  If the request is successful, then this action returns a value of Success.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the request is successful, then this action returns a value of Success."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

This example describes how to change the status of the new item request.

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/newItemRequests"

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.

{

 "name": "changeStatus",

 "parameters": [{

  "orgCode": "V1"

 },

 {

  "nirNumber": "PLM31455_NIR001"

 },

 {

  "toStatusName": "Open"

 }]

}


{

   "name" : "changeStatus",

   "parameters" :   [

   { "orgCode" : "V1" },

   { "orgId" : 204 },

   { "nirNumber" : "Cindy0305_NIR001" },

   { "nirId" : 300100170157390 },

   { "toStatusName" : "Definition" } ,

   { "toStatusCode" : "20" },

   { "comments": "Definition"}

   ]

}

Example Response Body

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

{
	"Success"
}

Back to Top