Jump to

• Request
• Response

replaceSecondaryOrganizations

post

/ccapp/v1/profiles/{id}/replaceSecondaryOrganizations

Replace Secondary Organizations. This operation is used to replace the secondary organizations for the profile. Optionally takes the x-ccasset-language header to get translated content in another language.

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 : replaceSecondaryOrganizations_request

Type: object

Show Source

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

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

Example:

{
    "secondaryOrganizations":[
        {
            "id":"200001"
        }
    ]
}

Nested Schema : secondaryOrganizations

Type: array

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

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "id":{
            "description":"ID of the organization to be replaced.",
            "type":"string"
        }
    },
    "required":[
        "id"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : replaceSecondaryOrganizations_response

Type: object

Show Source

• secondaryOrganizations(optional): array secondaryOrganizations
  List of secondary organizations replaced as part of the request from the profile.

{
    "properties":{
        "secondaryOrganizations":{
            "description":"List of secondary organizations replaced as part of the request from the profile.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"ID of the organization replaced.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : secondaryOrganizations

Type: array

List of secondary organizations replaced as part of the request from the profile.

Show Source

• Array of: object items

{
    "description":"List of secondary organizations replaced as part of the request from the profile.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"ID of the organization replaced.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "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/replaceSecondaryOrganizations"
        }
    ],
    "secondaryOrganizations":[
        {
            "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| |------------------|------------------| |22015|If some internal error occurs while replacing secondary organizations to the profile.| |22018|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