PUT api/2.0/crm/case/access This function requires authentication

Description

Sets access rights to the list of cases with the IDs specified in the request.

Parameters

Name	Description	Type	Example
casesid sent in body	List of case IDs	Collection of numbers collection	1234
isPrivate sent in body	Case privacy: private or not	Bool value	true
accessList sent in body	List of users with access	Collection of guids collection	9924256A-739C-462b-AF15-E652A3B1B6EB

Example

PUT api/2.0/crm/case/access
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "casesid": [
    1234
  ],
  "isPrivate": true,
  "accessList": [
    "9924256A-739C-462b-AF15-E652A3B1B6EB"
  ]
}

Returns

List of cases

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "Members": [
        {
          "SmallFotoUrl": "url to foto",
          "MediumFotoUrl": "url to foto",
          "DisplayName": "Tadjeddine Bachir",
          "IsCompany": false,
          "AccessList": [
            {
              "Id": "00000000-0000-0000-0000-000000000000",
              "DisplayName": "Mike Zanyatski",
              "Title": "Manager",
              "AvatarSmall": "url to small avatar",
              "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
            }
          ],
          "IsPrivate": true,
          "IsShared": false,
          "ShareType": 0,
          "Currency": {
            "Title": "Chinese Yuan",
            "Symbol": "¥",
            "Abbreviation": "CNY",
            "CultureName": "CN",
            "IsConvertable": true,
            "IsBasic": false
          },
          "CanEdit": true,
          "CanDelete": true,
          "id": 1234
        }
      ],
      "CreateBy": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "Created": "2020-12-08T17:37:04.5736385Z",
      "Title": "Exhibition organization",
      "IsClosed": false,
      "IsPrivate": false,
      "AccessList": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "DisplayName": "Mike Zanyatski",
          "Title": "Manager",
          "AvatarSmall": "url to small avatar",
          "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
        }
      ],
      "CanEdit": true,
      "CustomFields": [
        {
          "EntityId": 14523423,
          "Label": "Birthdate",
          "FieldValue": "2020-12-08T17:37:04.5916406Z",
          "FieldType": 5,
          "Position": 10,
          "Mask": "",
          "id": 1234
        }
      ],
      "id": 1234
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <Members>
      <SmallFotoUrl>url to foto</SmallFotoUrl>
      <MediumFotoUrl>url to foto</MediumFotoUrl>
      <DisplayName>Tadjeddine Bachir</DisplayName>
      <IsCompany>False</IsCompany>
      <AccessList>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <DisplayName>Mike Zanyatski</DisplayName>
        <Title>Manager</Title>
        <AvatarSmall>url to small avatar</AvatarSmall>
        <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
      </AccessList>
      <IsPrivate>True</IsPrivate>
      <IsShared>False</IsShared>
      <ShareType>0</ShareType>
      <Currency>
        <Title>Chinese Yuan</Title>
        <Symbol>¥</Symbol>
        <Abbreviation>CNY</Abbreviation>
        <CultureName>CN</CultureName>
        <IsConvertable>True</IsConvertable>
        <IsBasic>False</IsBasic>
      </Currency>
      <CanEdit>True</CanEdit>
      <CanDelete>True</CanDelete>
      <id>1234</id>
    </Members>
    <CreateBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </CreateBy>
    <Created>2020-12-08T17:37:04.5736385Z</Created>
    <Title>Exhibition organization</Title>
    <IsClosed>False</IsClosed>
    <IsPrivate>False</IsPrivate>
    <AccessList>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </AccessList>
    <CanEdit>True</CanEdit>
    <CustomFields>
      <EntityId>14523423</EntityId>
      <Label>Birthdate</Label>
      <FieldValue>2020-12-08T17:37:04.5916406Z</FieldValue>
      <FieldType>5</FieldType>
      <Position>10</Position>
      <Mask />
      <id>1234</id>
    </CustomFields>
    <id>1234</id>
  </response>
</result>