Jump to

• Request
• Response

updateProfileContextList

put

/ccadmin/v1/profileContextLists/{id}

Update Profile Context List. Update a profileContextList item. Note that when a profileContextList is updated, the JSON should contain a representation of all profileContexts. If the JSON array from the profileContexts property contains a single element, for example, then all other profileContexts will be deleted. Note that the "propertyName" property is all that is needed to identify an existing profileContext, so providing other properties that are unchanged is optional.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The ID of the profileContextList to be updated.

Body ()

Root Schema : updateProfileContextList_request

Type: object

Show Source

• id(optional): string
  The ID of the profileContextList item to be updated. (read-only)
• profileContexts(optional): array profileContexts
  The ordered list of profileContexts.

{
    "properties":{
        "profileContexts":{
            "description":"The ordered list of profileContexts.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "priceListGroupList":{
                        "description":"The list of available priceListGroups for the profileContext. Properties other than \"id\" may be visible, but cannot be updated by this endpoint.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "id":{
                                    "description":"The ID of the priceListGroup. Note that updating the ID property just updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "propertyName":{
                        "description":"The name of the profile boolean property that, when true on the current profile, will cause the profileContext to be active. A given property name can only appear once in the profileContexts list.",
                        "type":"string"
                    },
                    "defaultPriceListGroup":{
                        "description":"The default priceListGroup for the profileContext. Properties other than \"id\" may be visible, but are not editable via this endpoint.",
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"The ID of the default priceListGroup. Note that updating this ID merely updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.",
                                "type":"string"
                            }
                        },
                        "required":[
                            "id"
                        ]
                    }
                },
                "required":[
                    "propertyName"
                ]
            }
        },
        "id":{
            "description":"The ID of the profileContextList item to be updated. (read-only)",
            "type":"string"
        }
    },
    "example":{
        "profileContexts":[
            {
                "priceListGroupList":[
                    {
                        "id":"defaultPriceGroup"
                    }
                ],
                "propertyName":"active",
                "defaultPriceListGroup":{
                    "id":"defaultPriceGroup"
                }
            }
        ],
        "id":"defaultProfileContextList"
    }
}

Example:

{
    "profileContexts":[
        {
            "priceListGroupList":[
                {
                    "id":"defaultPriceGroup"
                }
            ],
            "propertyName":"active",
            "defaultPriceListGroup":{
                "id":"defaultPriceGroup"
            }
        }
    ],
    "id":"defaultProfileContextList"
}

Nested Schema : profileContexts

Type: array

The ordered list of profileContexts.

Show Source

• Array of: object items

{
    "description":"The ordered list of profileContexts.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "priceListGroupList":{
                "description":"The list of available priceListGroups for the profileContext. Properties other than \"id\" may be visible, but cannot be updated by this endpoint.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "id":{
                            "description":"The ID of the priceListGroup. Note that updating the ID property just updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.",
                            "type":"string"
                        }
                    }
                }
            },
            "propertyName":{
                "description":"The name of the profile boolean property that, when true on the current profile, will cause the profileContext to be active. A given property name can only appear once in the profileContexts list.",
                "type":"string"
            },
            "defaultPriceListGroup":{
                "description":"The default priceListGroup for the profileContext. Properties other than \"id\" may be visible, but are not editable via this endpoint.",
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The ID of the default priceListGroup. Note that updating this ID merely updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.",
                        "type":"string"
                    }
                },
                "required":[
                    "id"
                ]
            }
        },
        "required":[
            "propertyName"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• defaultPriceListGroup(optional): object defaultPriceListGroup
  The default priceListGroup for the profileContext. Properties other than "id" may be visible, but are not editable via this endpoint.
• priceListGroupList(optional): array priceListGroupList
  The list of available priceListGroups for the profileContext. Properties other than "id" may be visible, but cannot be updated by this endpoint.
• propertyName: string
  The name of the profile boolean property that, when true on the current profile, will cause the profileContext to be active. A given property name can only appear once in the profileContexts list.

{
    "type":"object",
    "properties":{
        "priceListGroupList":{
            "description":"The list of available priceListGroups for the profileContext. Properties other than \"id\" may be visible, but cannot be updated by this endpoint.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The ID of the priceListGroup. Note that updating the ID property just updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.",
                        "type":"string"
                    }
                }
            }
        },
        "propertyName":{
            "description":"The name of the profile boolean property that, when true on the current profile, will cause the profileContext to be active. A given property name can only appear once in the profileContexts list.",
            "type":"string"
        },
        "defaultPriceListGroup":{
            "description":"The default priceListGroup for the profileContext. Properties other than \"id\" may be visible, but are not editable via this endpoint.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The ID of the default priceListGroup. Note that updating this ID merely updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.",
                    "type":"string"
                }
            },
            "required":[
                "id"
            ]
        }
    },
    "required":[
        "propertyName"
    ]
}

Nested Schema : defaultPriceListGroup

Type: object

The default priceListGroup for the profileContext. Properties other than "id" may be visible, but are not editable via this endpoint.

Show Source

• id: string
  The ID of the default priceListGroup. Note that updating this ID merely updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.

{
    "description":"The default priceListGroup for the profileContext. Properties other than \"id\" may be visible, but are not editable via this endpoint.",
    "type":"object",
    "properties":{
        "id":{
            "description":"The ID of the default priceListGroup. Note that updating this ID merely updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.",
            "type":"string"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : priceListGroupList

Type: array

The list of available priceListGroups for the profileContext. Properties other than "id" may be visible, but cannot be updated by this endpoint.

Show Source

• Array of: object items

{
    "description":"The list of available priceListGroups for the profileContext. Properties other than \"id\" may be visible, but cannot be updated by this endpoint.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"The ID of the priceListGroup. Note that updating the ID property just updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  The ID of the priceListGroup. Note that updating the ID property just updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The ID of the priceListGroup. Note that updating the ID property just updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateProfileContextList_response

Type: object

Show Source

• id(optional): string
  The ID of the profileContextList item.
• profileContexts(optional): array profileContexts
  The ordered list of profileContexts. If present, this list much contain a representation of every profileContext to be retained. For existing profileContexts, only the "propertyName" property need be provided.

{
    "properties":{
        "profileContexts":{
            "description":"The ordered list of profileContexts. If present, this list much contain a representation of every profileContext to be retained. For existing profileContexts, only the \"propertyName\" property need be provided.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "priceListGroupList":{
                        "description":"The array of available priceListGroups. This list should contain the defaultPriceListGroup, as well.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "id":{
                                    "description":"The ID of the priceListGroup.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "propertyName":{
                        "description":"The name of the profile boolean property that, when true on the current profile, will cause the profileContext to (potentially) be active.",
                        "type":"string"
                    },
                    "defaultPriceListGroup":{
                        "description":"The default priceListGroup for the profile contexts",
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"The ID of the default price list group. Note that updating this ID merely updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "id":{
            "description":"The ID of the profileContextList item.",
            "type":"string"
        }
    }
}

Nested Schema : profileContexts

Type: array

The ordered list of profileContexts. If present, this list much contain a representation of every profileContext to be retained. For existing profileContexts, only the "propertyName" property need be provided.

Show Source

• Array of: object items

{
    "description":"The ordered list of profileContexts. If present, this list much contain a representation of every profileContext to be retained. For existing profileContexts, only the \"propertyName\" property need be provided.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "priceListGroupList":{
                "description":"The array of available priceListGroups. This list should contain the defaultPriceListGroup, as well.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "id":{
                            "description":"The ID of the priceListGroup.",
                            "type":"string"
                        }
                    }
                }
            },
            "propertyName":{
                "description":"The name of the profile boolean property that, when true on the current profile, will cause the profileContext to (potentially) be active.",
                "type":"string"
            },
            "defaultPriceListGroup":{
                "description":"The default priceListGroup for the profile contexts",
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The ID of the default price list group. Note that updating this ID merely updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• defaultPriceListGroup(optional): object defaultPriceListGroup
  The default priceListGroup for the profile contexts
• priceListGroupList(optional): array priceListGroupList
  The array of available priceListGroups. This list should contain the defaultPriceListGroup, as well.
• propertyName(optional): string
  The name of the profile boolean property that, when true on the current profile, will cause the profileContext to (potentially) be active.

{
    "type":"object",
    "properties":{
        "priceListGroupList":{
            "description":"The array of available priceListGroups. This list should contain the defaultPriceListGroup, as well.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The ID of the priceListGroup.",
                        "type":"string"
                    }
                }
            }
        },
        "propertyName":{
            "description":"The name of the profile boolean property that, when true on the current profile, will cause the profileContext to (potentially) be active.",
            "type":"string"
        },
        "defaultPriceListGroup":{
            "description":"The default priceListGroup for the profile contexts",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The ID of the default price list group. Note that updating this ID merely updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : defaultPriceListGroup

Type: object

The default priceListGroup for the profile contexts

Show Source

• id(optional): string
  The ID of the default price list group. Note that updating this ID merely updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.

{
    "description":"The default priceListGroup for the profile contexts",
    "type":"object",
    "properties":{
        "id":{
            "description":"The ID of the default price list group. Note that updating this ID merely updates a reference to an existing priceListGroup, and does not modify the priceListGroup itself.",
            "type":"string"
        }
    }
}

Nested Schema : priceListGroupList

Type: array

The array of available priceListGroups. This list should contain the defaultPriceListGroup, as well.

Show Source

• Array of: object items

{
    "description":"The array of available priceListGroups. This list should contain the defaultPriceListGroup, as well.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"The ID of the priceListGroup.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  The ID of the priceListGroup.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The ID of the priceListGroup.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "profileContexts":[
        {
            "priceListGroupList":[
                {
                    "id":"defaultPriceGroup"
                }
            ],
            "propertyName":"active",
            "defaultPriceListGroup":{
                "id":"defaultPriceGroup"
            }
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/profileContextLists/defaultProfileContextList"
        }
    ],
    "id":"defaultProfileContextList"
}

Default Response

The error response

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