Jump to

• Request
• Response

updateParentOrganization

post

/ccadmin/v1/profiles/{id}/updateParentOrganization

Updating a profile's parent organization and retaining the old parent in the profile's secondary organizations list with the existing roles.If the new parent is already part of the secondary organizations list,it is removed from that list and added as the parent with same roles.

Request

Supported Media Types

• application/json

Path Parameters

• id: string

Header Parameters

• X-CCAsset-Language(optional): string
  The asset language of the request

Body ()

Root Schema : updateParentOrganization_request

Type: object

Show Source

• parentOrganization: object parentOrganization
  List of secondary organizations that need to be replaced with the given for the profile.

{
    "properties":{
        "parentOrganization":{
            "description":"List of secondary organizations that need to be replaced with the given for the profile.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"ID of the organization to be replaced.",
                    "type":"string"
                }
            }
        }
    },
    "required":[
        "parentOrganization"
    ],
    "example":{
        "parentOrganization":{
            "id":"200001"
        }
    }
}

Example:

{
    "parentOrganization":{
        "id":"200001"
    }
}

Nested Schema : parentOrganization

Type: object

List of secondary organizations that need to be replaced with the given for the profile.

Show Source

• id(optional): string
  ID of the organization to be replaced.

{
    "description":"List of secondary organizations that need to be replaced with the given for the profile.",
    "type":"object",
    "properties":{
        "id":{
            "description":"ID of the organization to be replaced.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateParentOrganization_response

Type: object

Show Source

• parentOrganization(optional): object parentOrganization
  parent organization id replaced as part of the request from the profile.

{
    "properties":{
        "parentOrganization":{
            "description":"parent organization id replaced as part of the request from the profile.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"ID of the organization replaced.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : parentOrganization

Type: object

parent organization id replaced as part of the request from the profile.

Show Source

• id(optional): string
  ID of the organization replaced.

{
    "description":"parent organization id replaced as part of the request from the profile.",
    "type":"object",
    "properties":{
        "id":{
            "description":"ID of the organization replaced.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/profiles/120175/updateParentOrganization"
        }
    ],
    "parentOrganization":[
        {
            "id":"200001"
        }
    ]
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |22001|If there is any internal error while fetching the profile.| |22046|If the user input is null or empty.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top