POST Worklist/ShareFolder

Allows the client to change the sharing property of a worklist folder between public and private.

Request Information

URI Parameters

None.

Body Parameters

The parameters.

ShareFolderRequest
NameDescriptionTypeAdditional information
Uuid

Gets or sets the UUID of the folder.

string

None.

UserLogin

The login name of the User.

string

None.

IsPublic

Gets or sets a value indicating whether the folder is public or not.

boolean

None.

WorklistType

Gets or sets the type of the worklist. Possible values are Legacy, Qbe and Link.

WorklistType

None.

Request Formats

application/json, text/json

Sample:
{
  "Uuid": "sample string 1",
  "UserLogin": "sample string 2",
  "IsPublic": true,
  "WorklistType": 0
}

application/xml, text/xml

Sample:
<ShareFolderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Worklists">
  <IsPublic>true</IsPublic>
  <UserLogin>sample string 2</UserLogin>
  <Uuid>sample string 1</Uuid>
  <WorklistType>Legacy</WorklistType>
</ShareFolderRequest>

Response Information

Resource Description

ShareFolderResult
NameDescriptionTypeAdditional information
StatusMessage

Gets or sets the status message.

string

None.

Succeeded

Gets or sets a value indicating whether this is succeeded.

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "StatusMessage": "sample string 1",
  "Succeeded": true
}

application/xml, text/xml

Sample:
<ShareFolderResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Worklists">
  <StatusMessage>sample string 1</StatusMessage>
  <Succeeded>true</Succeeded>
</ShareFolderResult>