Login
    Contents x
    Sites
    • 23 May 2023
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Sites

    • Updated on 23 May 2023
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    Article Summary


     GET   /Sites

    Returns a list of sites.

    Query Parameters
    ParameterTypeDescription
    qStringA VisualVault REST API Data Query.
    Response Codes
    CodeDescription
    400Bad Request


     GET   /Sites/{id}

    Get site properties for a site by ID.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe site id.


     POST   /Sites

    Create a new site.

    Body Parameters
    ParameterTypeDescription
    nameStringThe name of the site.
    descriptionStringThe site description.
    sitetypeStringThe type of site.
    • Location
    • Customer
    • Supplier


     PUT   /Sites/{id}

    Update site properties.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe site id.
    Body Parameters
    ParameterTypeDescription
    nameStringThe name of the site.
    descriptionStringThe site description.


     GET   /Sites/{id}/groups/{childId}

    Get a group from a specified site.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe site id.
    childId*GuidThe group id.
    Query Parameters
    ParameterTypeDescription
    offsetStringSets an offset to the start of the search.
    limitIntSets a limit to the number of values returned.


     GET   /Sites/{id}/groups

    Get a list of groups belonging to a site.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe site id.
    Query Parameters
    ParameterTypeDescription
    offsetStringSets an offset to the start of the search.
    limitIntSets a limit to the number of values returned.
    qStringA VisualVault REST API Data Query.


     POST   /Sites/{id}/groups

    Create new groups for a site.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe site id.
    Body Parameters
    ParameterTypeDescription
    nameStringName of the group.
    descriptionStringA description of the group.


     PUT   /Sites/{id}/groups/{childId}

    Update a group for a site.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe site id.
    childId*GuidThe group id.
    Body Parameters
    ParameterTypeDescription
    nameStringThe group name.
    descriptionStringThe group description.


     GET   /Sites/{id}/users/{childId}

    Get properties of a site user.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe site id.
    childId*GuidThe user id.
    Response Codes
    CodeDescription
    404Not Found


     GET   /Sites/{id}/users

    Get a list of users for a site.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe site id.
    Query Parameters
    ParameterTypeDescription
    sortStringThe name of a data column to sort by.
    sortDirStringSort direction.
    • asc: Ascending order
    • desc: Descending order
    offsetStringSets an offset to the start of the search.
    limitIntSets a limit to the number of values returned.
    qStringA VisualVault REST API Data Query.
    Response Codes
    CodeDescription
    404Not Found


     POST   /Sites/{id}/users

    Create new users for a site.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe site id.
    Body Parameters
    ParameterTypeDescription
    userId*StringUser ID of the user.
    firstname*StringFirst name of the user.
    middleinitialStringMiddle initial of the user.
    lastname*StringLast name of the user.
    emailaddress*StringEmail address of the user.
    password*StringUser password.
    passwordneverexpiresBoolDoes the password expire?
    passwordexpiresdatetimeDate when the user password will expire.
    mustchangepasswordBoolForces a password change upon first login.
    sendemailBoolSend an email to the user once the account is created.


     PUT   /Sites/{id}/users/{childId}

    Update user properties belonging to a site.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe site id.
    childId*GuidThe user id.
    Body Parameters
    ParameterTypeDescription
    firstnameStringUser first name.
    middleinitialStringUser middle initial.
    lastnameStringUser last name.
    emailaddressStringEmail address.
    employmentstatusStringThe user's employment status.
    employeeidStringThe user's employee ID.
    passwordneverexpiresBoolDoes the user password expire?
    useridneverexpiresBoolDoes the user ID expire?
    passwordexpiresdatetimeDate of expiration for the user password.
    passwordanswerStringThe password security answer.
    passwordquestionStringThe password security question.
    useridexpiresdatetimeThe expiration date for the user ID.


     PUT   /Sites/ChangeUserSite

    Change the current site for a user.

    Body Parameters
    ParameterTypeDescription
    useridGuidThe user ID.
    newsiteidGuidThe site ID.
    Was this article helpful?
    What's Next
    VisualVault is a cloud-native content platform upon which you can quickly build line-of-business solutions with low-code and no-code apps and existing templates. Or, together, we can create the transformative enterprise solutions you seek as you build a digital-first workplace.

    Login to Document360 view all articles and content.
    Why VisualVault?
    Company
    Platform
    Solutions
    Existing Users
    Connect With Us
    Sales and Support
    Copyright © VisualVault LLC. All Rights Reserved
    Change password!
    Changing your password will log you out immediately. Use the new password to log back in.
    Change profile
    Success!
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    Logout
    ESC

    Eddy, a super-smart generative AI, opening up ways to have tailored queries and responses