Jump to

• Request
• Response

Get Set ID Assignments for Business Unit

get

/ccstore/v1/selfservice/setIdAssignmentsBusinessUnit

Returns set ID assignments for business units

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A list of set ID assignments for the business unit

Body ()

Root Schema : schema

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/setIdAssignment_response"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object setIdAssignment_response

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/setIdAssignment_response"
    }
}

Nested Schema : setIdAssignment_response

Type: object

Show Source

• DeterminantType: string
  The determinant type.

  Example: BU
• DeterminantValue: integer
  The determinant value.

  Example: 204
• OrganizationCode: string
  The code for the organization.

  Example: Vision Operations
• OrganizationId: string
  The unique identifier for the organization.

  Example: 204
• ReferenceGroupName: string
  The reference group name.

  Example: AR_REMIT_TO_ADDRESS
• SetCode: string
  The code for the set.

  Example: Vision Operations 204
• SetId: string
  The unique identifier for the set.

  Example: 204

{
    "type":"object",
    "properties":{
        "ReferenceGroupName":{
            "description":"The reference group name.",
            "type":"string",
            "example":"AR_REMIT_TO_ADDRESS"
        },
        "DeterminantValue":{
            "description":"The determinant value.",
            "type":"integer",
            "example":204
        },
        "DeterminantType":{
            "description":"The determinant type.",
            "type":"string",
            "example":"BU"
        },
        "OrganizationCode":{
            "description":"The code for the organization.",
            "type":"string",
            "example":"Vision Operations"
        },
        "OrganizationId":{
            "description":"The unique identifier for the organization.",
            "type":"string",
            "example":"204"
        },
        "SetId":{
            "description":"The unique identifier for the set.",
            "type":"string",
            "example":"204"
        },
        "SetCode":{
            "description":"The code for the set.",
            "type":"string",
            "example":"Vision Operations 204"
        }
    }
}

Default Response

The error response.

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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