Jump to

• Request
• Response

Create new version of a plan

post

/fscmRestApi/resources/11.13.18.05/inspectionPlans/{InspectionPlanId}/action/createNewVersion

Creates a new version of the plan by end dating the previous version. Returns an error if the end date parameter is empty.

Request

Path Parameters

• InspectionPlanId(required): integer(int64)
  Value that uniquely identifies the inspection plan.

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.

Supported Media Types

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

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

Root Schema : schema

Type: object

Show Source

• effectiveStartDate: string (date-time)
  Effective start date of the new version of the inspection plan.

{
    "type":"object",
    "properties":{
        "effectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the new version of the inspection plan.",
            "format":"date-time",
            "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): object result
  Additional Properties Allowed: additionalProperties

  Returns a status and error message indicating if the creation of a new version of the plan is successful.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Returns a status and error message indicating if the creation of a new version of the plan is successful."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Returns a status and error message indicating if the creation of a new version of the plan is successful."
}

Returns a status and error message indicating if the creation of a new version of the plan is successful.

Back to Top