Jump to

• Request
• Response

Copy inspection plan within or across organizations

post

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

Creates a copy of a plan based on the context and organizations list passed. Returns an error if an empty context is passed.

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

• copyContext: object copyContext
  Additional Properties Allowed: additionalProperties

  Context of copy operation containing key value pairs. Allowed attributes are Name, InventoryItemId, CategorySetId, CategoryId, AssetId, AssetGroupId, WorkCenterId, ResourceId, CopyRules, CopyAttachments, and CopyCriteria.
• organizations: array organizations
  List of organizations where the inspection plan copy is created.

{
    "type":"object",
    "properties":{
        "organizations":{
            "type":"array",
            "description":"List of organizations where the inspection plan copy is created.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "copyContext":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Context of copy operation containing key value pairs. Allowed attributes are Name, InventoryItemId, CategorySetId, CategoryId, AssetId, AssetGroupId, WorkCenterId, ResourceId, CopyRules, CopyAttachments, and CopyCriteria.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : copyContext

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Context of copy operation containing key value pairs. Allowed attributes are Name, InventoryItemId, CategorySetId, CategoryId, AssetId, AssetGroupId, WorkCenterId, ResourceId, CopyRules, CopyAttachments, and CopyCriteria.",
    "nullable":true
}

Context of copy operation containing key value pairs. Allowed attributes are Name, InventoryItemId, CategorySetId, CategoryId, AssetId, AssetGroupId, WorkCenterId, ResourceId, CopyRules, CopyAttachments, and CopyCriteria.

Nested Schema : organizations

Type: array

List of organizations where the inspection plan copy is created.

Show Source

• Array of: number

{
    "type":"array",
    "description":"List of organizations where the inspection plan copy is created.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

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 copy of a plan is successful.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Returns a status and error message indicating if the copy of a 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 copy of a plan is successful."
}

Returns a status and error message indicating if the copy of a plan is successful.

Back to Top