Jump to

• Request
• Response

Copy inventory organizations.

post

/fscmRestApi/resources/11.13.18.05/inventoryOrganizations/action/copyInventoryOrganizations

Copy an inventory organization and specified dependent setup data. A source organization is specified along with additional setup data copied for that organization. You can create new organizations as duplicates of the source inventory organization by specifying a new name, code, and location. The duplicate copies use source organization settings.

Request

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

• copyParamsList: array copyParamsList
  Specifies the set of additional setup data to copy for all new organizations. Valid values are INV_ORG_PARAM, DATA_SECURITY, PLANT_PARAMETERS, SUBINVENTORIES, and LOCATORS.
• organizationCopies: array organizationCopies
  Specifies the set of new organizations to create. Each element of the set must contain a Name, a Code, and a Location for the new inventory organization.
• sourceOrganizationCode: string
  The user-supplied short code that uniquely identifies the inventory organization to copy. If the source organization ID is also an element in the request, this attribute is ignored.
• sourceOrganizationId: string
  The value that uniquely identifies the inventory organization to copy. The source organization must be identified by the ID, the Code, or the Name, although only one attribute is required.
• sourceOrganizationName: string
  The user-supplied name that uniquely identifies the inventory organization to copy. If either the source organization ID or the source organization code are elements in the request, this attribute is ignored.

{
    "type":"object",
    "properties":{
        "sourceOrganizationName":{
            "type":"string",
            "description":"The user-supplied name that uniquely identifies the inventory organization to copy. If either the source organization ID or the source organization code are elements in the request, this attribute is ignored.",
            "nullable":true
        },
        "organizationCopies":{
            "type":"array",
            "description":"Specifies the set of new organizations to create. Each element of the set must contain a Name, a Code, and a Location for the new inventory organization.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "sourceOrganizationId":{
            "type":"string",
            "description":"The value that uniquely identifies the inventory organization to copy. The source organization must be identified by the ID, the Code, or the Name, although only one attribute is required.",
            "nullable":true
        },
        "copyParamsList":{
            "type":"array",
            "description":"Specifies the set of additional setup data to copy for all new organizations. Valid values are INV_ORG_PARAM, DATA_SECURITY, PLANT_PARAMETERS, SUBINVENTORIES, and LOCATORS.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "sourceOrganizationCode":{
            "type":"string",
            "description":"The user-supplied short code that uniquely identifies the inventory organization to copy. If the source organization ID is also an element in the request, this attribute is ignored.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : copyParamsList

Type: array

Specifies the set of additional setup data to copy for all new organizations. Valid values are INV_ORG_PARAM, DATA_SECURITY, PLANT_PARAMETERS, SUBINVENTORIES, and LOCATORS.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Specifies the set of additional setup data to copy for all new organizations. Valid values are INV_ORG_PARAM, DATA_SECURITY, PLANT_PARAMETERS, SUBINVENTORIES, and LOCATORS.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : organizationCopies

Type: array

Specifies the set of new organizations to create. Each element of the set must contain a Name, a Code, and a Location for the new inventory organization.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Specifies the set of new organizations to create. Each element of the set must contain a Name, a Code, and a Location for the new inventory organization.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

  If the action completes successfully, then copyInventoryOrganizations returns the job ID that creates the new organizations and dependent data.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"If the action completes successfully, then copyInventoryOrganizations returns the job ID that creates the new organizations and dependent data."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"If the action completes successfully, then copyInventoryOrganizations returns the job ID that creates the new organizations and dependent data."
}

If the action completes successfully, then copyInventoryOrganizations returns the job ID that creates the new organizations and dependent data.

Back to Top