Jump to

• Request
• Response

Get a user group by name

get

/userGroups/findByName

Request

Query Parameters

• contentTypeId: string
  The unique identifier of the ContentType object.
• nameToken(required): string
  The string you believe to be in the name of the user group that you are looking for.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ResultListBOUserGroupKeyBO

Type: object

Show Source

• count: integer (int32)
• hasMore(required): boolean
  Title: Has More

  Default Value: false

  Boolean indicating whether or not the collection contains more items than were returned in this request. Defaults to false.
• items(required): array Items
  Title: Items

  The collection of of the requested resources meeting your criteria.
• limit(required): integer (int32)
  Title: Limit

  The number of items this result is limited to. Used in conjunction with offset for pagination.
• links: array Links
  Title: Links

  REST API canonical and/or collection links for this Singular Resource
• offset(required): integer (int32)
  Title: Offset

  The item index at which this resultset starts. Used in conjunction with limit for pagination.

{
    "required":[
        "items",
        "hasMore",
        "limit",
        "offset"
    ],
    "type":"object",
    "properties":{
        "items":{
            "title":"Items",
            "description":"The collection of of the requested resources meeting your criteria.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UserGroupKeyBO"
            },
            "readOnly":false
        },
        "hasMore":{
            "title":"Has More",
            "description":"Boolean indicating whether or not the collection contains more items than were returned in this request.  Defaults to false.",
            "default":false,
            "type":"boolean",
            "readOnly":false
        },
        "limit":{
            "format":"int32",
            "title":"Limit",
            "description":"The number of items this result is limited to.  Used in conjunction with offset for pagination.",
            "type":"integer",
            "readOnly":false
        },
        "offset":{
            "format":"int32",
            "title":"Offset",
            "description":"The item index at which this resultset starts.  Used in conjunction with limit for pagination.",
            "type":"integer",
            "readOnly":false
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "count":{
            "format":"int32",
            "type":"integer"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The collection of of the requested resources meeting your criteria.

Show Source

• Array of: object UserGroupKeyBO
  Documentation for BO mode: UserGroupKeyBO

{
    "title":"Items",
    "description":"The collection of of the requested resources meeting your criteria.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UserGroupKeyBO"
    },
    "readOnly":false
}

Nested Schema : Links

Type: array

Title: Links

REST API canonical and/or collection links for this Singular Resource

Show Source

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

Nested Schema : UserGroupKeyBO

Type: object

Documentation for BO mode: UserGroupKeyBO

Show Source

• businessUnits: array Business Units
  Title: Business Units

  The business units assigned to the user group.
• family: string
  Title: Family

  Read Only: true

  The Fusion family that this user group type belongs to
• links: array Links
  Title: Links

  Read Only: true

  The collection links related to this resource
• name: string
  Title: Name

  Read Only: true

  Maximum Length: 255

  The localized name of the user group. The name field can only be used for sorting.
• namespaceFromStripe: string
• product: string
  Title: Product

  Read Only: true

  The Fusion product that this user group type belongs to
• recordId: string
  Title: Record Id

  The unique identifier from the TAG table that represent a userGroups resource
• referenceKey: string
  Title: Reference Key

  Maximum Length: 255

  The non localized name of the user group
• stripeCd: string
  Title: Stripe CD

  Read Only: true

  Maximum Length: 100

  Stripe for UserGroup

{
    "description":"Documentation for BO mode: UserGroupKeyBO",
    "type":"object",
    "properties":{
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier from the TAG table that represent a userGroups resource",
            "type":"string",
            "readOnly":false
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The non localized name of the user group",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"The localized name of the user group.  The name field can only be used for sorting.",
            "maxLength":255,
            "type":"string",
            "readOnly":true
        },
        "stripeCd":{
            "title":"Stripe CD",
            "description":"Stripe for UserGroup",
            "maxLength":100,
            "type":"string",
            "readOnly":true
        },
        "links":{
            "title":"Links",
            "description":"The collection links related to this resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "businessUnits":{
            "title":"Business Units",
            "description":"The business units assigned to the user group.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BusinessUnitKeyBO"
            },
            "readOnly":false
        },
        "namespaceFromStripe":{
            "type":"string"
        },
        "family":{
            "title":"Family",
            "description":"The Fusion family that this user group type belongs to",
            "type":"string",
            "readOnly":true
        },
        "product":{
            "title":"Product",
            "description":"The Fusion product that this user group type belongs to",
            "type":"string",
            "readOnly":true
        }
    }
}

Nested Schema : Business Units

Type: array

Title: Business Units

The business units assigned to the user group.

Show Source

• Array of: object BusinessUnitKeyBO
  BusinessUnitKeyBO has BusinessUnit OrgId.

{
    "title":"Business Units",
    "description":"The business units assigned to the user group.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BusinessUnitKeyBO"
    },
    "readOnly":false
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The collection links related to this resource

Show Source

• Array of: object Link

{
    "title":"Links",
    "description":"The collection links related to this resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

Nested Schema : BusinessUnitKeyBO

Type: object

BusinessUnitKeyBO has BusinessUnit OrgId.

Show Source

• businessUnitOrgId: integer (int64)
  Title: Business Unit OrgId

  The business unit OrgId of this business unit.

{
    "description":"BusinessUnitKeyBO has BusinessUnit OrgId.",
    "type":"object",
    "properties":{
        "businessUnitOrgId":{
            "format":"int64",
            "title":"Business Unit OrgId",
            "description":"The business unit OrgId of this business unit.",
            "type":"integer",
            "readOnly":false
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• mediaType: string
• method: string
• profile: string
• rel: string
• sinceVersion: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        },
        "profile":{
            "type":"string",
            "writeOnly":true
        },
        "sinceVersion":{
            "type":"string",
            "writeOnly":true
        }
    }
}

Back to Top