Jump to

• Request
• Response

Remove Users Assigned to a Program

post

/api/restapi/program/removeUsers

Send a request to this endpoint to remove users from a program.

Request

Header Parameters

• singleTransaction: boolean
  Enabling this boolean flag fails to complete the request if an error occurred while processing any user removal sent as part of the request.
  Allowed Values: [ "true", "false" ]

  Default Value: false

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityRemoveProgramUserPermissions

Type: object

Title: ApiEntityRemoveProgramUserPermissions

Show Source

• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• userNames: array userNames
  List of user names for removing users.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityRemoveProgramUserPermissions",
    "type":"object",
    "properties":{
        "userNames":{
            "type":"array",
            "description":"List of user names for removing users.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : userNames

Type: array

List of user names for removing users.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of user names for removing users.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

207 Response

The object was successfully integrated.

Body ()

Root Schema : List<ApiEntityRemoveProgramUserPermissionsResponse>

Type: array

Title: List<ApiEntityRemoveProgramUserPermissionsResponse>

Show Source

• Array of: object ApiEntityRemoveProgramUserPermissionsResponse
  Title: ApiEntityRemoveProgramUserPermissionsResponse

{
    "title":"List<ApiEntityRemoveProgramUserPermissionsResponse>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityRemoveProgramUserPermissionsResponse",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityRemoveProgramUserPermissionsResponse

Type: object

Title: ApiEntityRemoveProgramUserPermissionsResponse

Show Source

• message: string
  Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.
• programId: integer (int64)
  The unique identifier for the program.
• statusCode: integer (int32)
  The response code representing the state of the API operation.
• userName: string
  Maximum Length: 255

  Username of the user for permission assignment.

{
    "title":"ApiEntityRemoveProgramUserPermissionsResponse",
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userName":{
            "maxLength":255,
            "type":"string",
            "description":"Username of the user for permission assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "statusCode":{
            "type":"integer",
            "description":"The response code representing the state of the API operation.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Program service.

Back to Top