Jump to

• Request
• Response

Assign Permission Profiles To User

post

/api/restapi/document/assignUser

Use this endpoint to assign document permission profiles to multiple user.

Request

Header Parameters

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

  Default Value: false

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityDocumentUserPermissions

Type: object

Title: ApiEntityDocumentUserPermissions

Show Source

• documentId: integer (int64)
  The system-generated identifier of the file, folder, or template.
• path: string
  The path of the file or folder from it's root folder.
  The field is non-persistable and thus maximum length is not applicable.
• profiles: array profiles
  List of user profiles.
• scope: string
  Allowed Values: [ "genericPortfolio", "project", "template", "idea", "program", "strategy" ]

  The object name of the context the file or folder is created in.
• scopeId: integer (int64)
  The system-generated identifier of the object of the context the file or folder is created in.

{
    "title":"ApiEntityDocumentUserPermissions",
    "type":"object",
    "properties":{
        "path":{
            "type":"string",
            "description":"The path of the file or folder from it's root folder.<br />The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeId":{
            "type":"integer",
            "description":"The system-generated identifier of the object of the context the file or folder is created in.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "profiles":{
            "type":"array",
            "description":"List of user profiles.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityDocumentProfileInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "scope":{
            "type":"string",
            "description":"The object name of the context the file or folder is created in.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "genericPortfolio",
                "project",
                "template",
                "idea",
                "program",
                "strategy"
            ]
        },
        "documentId":{
            "type":"integer",
            "description":"The system-generated identifier of the file, folder, or template.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : profiles

Type: array

List of user profiles.

Show Source

• Array of: object ApiEntityDocumentProfileInput
  Title: ApiEntityDocumentProfileInput

{
    "type":"array",
    "description":"List of user profiles.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityDocumentProfileInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityDocumentProfileInput

Type: object

Title: ApiEntityDocumentProfileInput

Show Source

• documentProfileId: string
  Maximum Length: 255

  System-defined identifier of the document profile.
• userName: string
  Maximum Length: 255

  Username of the user for permission assignment.

{
    "title":"ApiEntityDocumentProfileInput",
    "type":"object",
    "properties":{
        "userName":{
            "maxLength":"255",
            "type":"string",
            "description":"Username of the user for permission assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "documentProfileId":{
            "maxLength":"255",
            "type":"string",
            "description":"System-defined identifier of the document profile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Assign File Permission Profiles to Multiple Users Using Codes Assign File Permission Profiles to Multiple Users Using IDs

Back to Top

Response

Supported Media Types

• application/json

207 Response

The object was successfully integrated.

Body ()

Root Schema : ApiEntityDocumentUserPermissionsResponse

Type: object

Title: ApiEntityDocumentUserPermissionsResponse

Show Source

• documentId: integer (int64)
  The system-generated identifier of the file, folder, or template.
• profiles: array profiles
  Profiles response with individual message and statusCodes.

{
    "title":"ApiEntityDocumentUserPermissionsResponse",
    "type":"object",
    "properties":{
        "profiles":{
            "type":"array",
            "description":"Profiles response with individual message and statusCodes.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProfileResponse",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "documentId":{
            "type":"integer",
            "description":"The system-generated identifier of the file, folder, or template.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : profiles

Type: array

Profiles response with individual message and statusCodes.

Show Source

• Array of: object ApiEntityProfileResponse
  Title: ApiEntityProfileResponse

{
    "type":"array",
    "description":"Profiles response with individual message and statusCodes.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProfileResponse",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityProfileResponse

Type: object

Title: ApiEntityProfileResponse

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.
• profileId: string
  Maximum Length: 255

  The system-defined unique identifier of an object profile.
• 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":"ApiEntityProfileResponse",
    "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"
            ]
        },
        "statusCode":{
            "type":"integer",
            "description":"The response code representing the state of the API operation.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "profileId":{
            "maxLength":"255",
            "type":"string",
            "description":"The system-defined unique identifier of an object profile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Document service. Verify the request contains valid data, then resubmit the request.

Back to Top