Jump to

• Request
• Response

Replace a user group

put

/userGroups/{id}

Request

Path Parameters

• id(required): string
  The unique identifier that represents a userGroups resource

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Request body for replacing a user group.

Match All

Request body for replacing a user group.

Show Source

• object schema

{
    "description":"Request body for replacing a user group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/UserGroupCreateRequest"
        }
    ]
}

Nested Schema : schema

Type: object

Show Source

• businessUnits: array businessUnits
• description: string
  Maximum Length: 1000
• localizedAttributes(required): array localizedAttributes
  Minimum Number of Items: 1

  The service requires an entry for every active locale.
• name(required): string
  Maximum Length: 255
• referenceKey(required): string
  Maximum Length: 255
• stripeCd(required): string
  Maximum Length: 100

{
    "required":[
        "referenceKey",
        "name",
        "stripeCd",
        "localizedAttributes"
    ],
    "type":"object",
    "properties":{
        "referenceKey":{
            "type":"string",
            "maxLength":255
        },
        "name":{
            "type":"string",
            "maxLength":255
        },
        "stripeCd":{
            "type":"string",
            "maxLength":100
        },
        "description":{
            "type":"string",
            "maxLength":1000
        },
        "businessUnits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BusinessUnitKeyBO"
            }
        },
        "localizedAttributes":{
            "description":"The service requires an entry for every active locale.",
            "type":"array",
            "minItems":1,
            "items":{
                "$ref":"#/components/schemas/UserGroupLocalizedAttributeRequest"
            }
        }
    }
}

Nested Schema : businessUnits

Type: array

Show Source

• Array of: object BusinessUnitKeyBO
  BusinessUnitKeyBO has BusinessUnit OrgId.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BusinessUnitKeyBO"
    }
}

Nested Schema : localizedAttributes

Type: array

Minimum Number of Items: 1

The service requires an entry for every active locale.

Show Source

• Array of: object UserGroupLocalizedAttributeRequest

{
    "description":"The service requires an entry for every active locale.",
    "type":"array",
    "minItems":1,
    "items":{
        "$ref":"#/components/schemas/UserGroupLocalizedAttributeRequest"
    }
}

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

Type: object

Show Source

• description(required): string
  Maximum Length: 1000
• localeId(required): string
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

{
    "required":[
        "localeId",
        "name",
        "description"
    ],
    "type":"object",
    "properties":{
        "localeId":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "description":{
            "type":"string",
            "maxLength":1000
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : UserGroupBO

Type: object

Documentation for BO mode: UserGroupBO

Show Source

• businessUnits: array Business Units
  Title: Business Units

  The business units assigned to the user group.
• dateAdded: string (date-time)
  Title: Date Added

  Read Only: true

  The date and time when this user group was added.

  Example: 2022-03-10
• dateModified: string (date-time)
  Title: Date Modified

  Read Only: true

  The date and time this user group was last modified.

  Example: 2022-03-10
• description: string
  Title: Description

  Maximum Length: 1000

  Localized description of 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
• localizedAttributes(required): array Localized Attributes
  Title: Localized Attributes

  List of LocalizedAttributes of this UserGroup in various Locales
• 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
• objectId: string
  Title: Object Id

  Read Only: true

  String representing the hierarchy of the user groups. All user groups are stored in the TAG table but they are currently NOT hierarchical
• 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: UserGroupBO",
    "required":[
        "localizedAttributes"
    ],
    "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
        },
        "dateAdded":{
            "format":"date-time",
            "title":"Date Added",
            "description":"The date and time when this user group was added.",
            "type":"string",
            "readOnly":true,
            "example":"2022-03-10"
        },
        "dateModified":{
            "format":"date-time",
            "title":"Date Modified",
            "description":"The date and time this user group was last modified.",
            "type":"string",
            "readOnly":true,
            "example":"2022-03-10"
        },
        "objectId":{
            "title":"Object Id",
            "description":"String representing the hierarchy of the user groups. All user groups are stored in the TAG table but they are currently NOT hierarchical",
            "type":"string",
            "readOnly":true
        },
        "description":{
            "title":"Description",
            "description":"Localized description of the user group",
            "maxLength":1000,
            "type":"string",
            "readOnly":false
        },
        "localizedAttributes":{
            "title":"Localized Attributes",
            "description":"List of LocalizedAttributes of this UserGroup in various Locales",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LocalizedAttributesBO"
            },
            "readOnly":false
        }
    }
}

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 : Localized Attributes

Type: array

Title: Localized Attributes

List of LocalizedAttributes of this UserGroup in various Locales

Show Source

• Array of: object LocalizedAttributesBO

{
    "title":"Localized Attributes",
    "description":"List of LocalizedAttributes of this UserGroup in various Locales",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LocalizedAttributesBO"
    },
    "readOnly":false
}

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
        }
    }
}

Nested Schema : LocalizedAttributesBO

Type: object

Show Source

• description: string
  Title: Description

  Maximum Length: 1000

  Localized description in the above Locale
• localeId(required): string
  Title: Locale Id

  Read Only: true

  RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 255

  Localized Name in the above Locale

{
    "description":"",
    "required":[
        "localeId",
        "name"
    ],
    "type":"object",
    "properties":{
        "localeId":{
            "title":"Locale Id",
            "description":"RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.",
            "type":"string",
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"Localized Name in the above Locale",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false
        },
        "description":{
            "title":"Description",
            "description":"Localized description in the above Locale",
            "maxLength":1000,
            "type":"string",
            "readOnly":false
        }
    }
}

Back to Top