POST Worklist/CreateLinkFolder

Create Link Folder

Request Information

URI Parameters

None.

Body Parameters

LinkFolderCreateRequest
NameDescriptionTypeAdditional information
DisplayName

DisplayName of the the LinkFolder.

string

None.

ParentUuid

string

None.

UserLogin

The login name of the User.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "DisplayName": "sample string 1",
  "ParentUuid": "sample string 2",
  "UserLogin": "sample string 3"
}

application/xml, text/xml

Sample:
<LinkFolderCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Worklists">
  <DisplayName>sample string 1</DisplayName>
  <ParentUuid>sample string 2</ParentUuid>
  <UserLogin>sample string 3</UserLogin>
</LinkFolderCreateRequest>

Response Information

Resource Description

LinkFolderCreateResult

LinkFolderCreateResult
NameDescriptionTypeAdditional information
Uuid

UUID of the newly created Link Folder

string

None.

LinkFolderId

Gets or sets the link folder identifier.

integer

None.

Succeeded

Denotes whether the Link Folder process request has been successful or not.

boolean

None.

Remarks

Summarize the Link Folder process result.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Uuid": "sample string 1",
  "LinkFolderId": 2,
  "Succeeded": true,
  "Remarks": "sample string 4"
}

application/xml, text/xml

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