POST Worklist/AddItemsToLinkFolder

Adds the records to link folder.

Request Information

URI Parameters

None.

Body Parameters

The parameters.

LinkFolderAddItemsParams
NameDescriptionTypeAdditional information
LinkFolderUuid

Uuid of the LinkFolder

 string

None.
Items

List of DICOM Study instance euids or display state uuid.

 Collection of LinkFolderItem

None.
UserLogin

The login name of the User.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "LinkFolderUuid": "sample string 1",
  "Items": [
    {
      "Identifier": "sample string 1",
      "IsDisplayState": true,
      "DataSourceUuid": "sample string 3",
      "IsRemoteStudy": true,
      "RemoteItemInfo": {
        "accessionNumber": "sample string 1",
        "addedBy": "sample string 2",
        "dataSource": "sample string 3",
        "dataSourceType": 4,
        "dicomSrUid": 1,
        "displayStateName": "sample string 5",
        "hasARReportInstance": "sample string 6",
        "identifier": "sample string 7",
        "instanceEUID": "sample string 8",
        "internalPatientUID": "sample string 9",
        "isValidForAR": true,
        "isValidForArReport": true,
        "patientFullName": "sample string 12",
        "patientUuid": "sample string 13",
        "procedureDescription": "sample string 14",
        "procedureModality": "sample string 15",
        "studyUID": 16,
        "snapshotOwner": "sample string 17",
        "snapshotOwnerUserName": "sample string 18",
        "birthDate": "2025-12-15T04:58:46",
        "displayTimestamp": "2025-12-15T04:58:46",
        "studyCompletionDate": "2025-12-15T04:58:46",
        "studyStatusCD": 1,
        "studyStatus": "sample string 19",
        "priority": "sample string 20",
        "studyImageCount": 1,
        "lastModifiedTimestamp": "2025-12-15T04:58:46",
        "reportStatusCode": 1,
        "totalNumberNote": 1,
        "totalNumberDoc": 1,
        "lastViewedTime": "2025-12-15T04:58:46",
        "displayStateFlag": 1,
        "procedureModifier": "sample string 21",
        "facilityCode": "sample string 22",
        "medicalCheckupCourseNo": "sample string 23",
        "medicalCheckupNo": "sample string 24",
        "reason": "sample string 25"
      }
    },
    {
      "Identifier": "sample string 1",
      "IsDisplayState": true,
      "DataSourceUuid": "sample string 3",
      "IsRemoteStudy": true,
      "RemoteItemInfo": {
        "accessionNumber": "sample string 1",
        "addedBy": "sample string 2",
        "dataSource": "sample string 3",
        "dataSourceType": 4,
        "dicomSrUid": 1,
        "displayStateName": "sample string 5",
        "hasARReportInstance": "sample string 6",
        "identifier": "sample string 7",
        "instanceEUID": "sample string 8",
        "internalPatientUID": "sample string 9",
        "isValidForAR": true,
        "isValidForArReport": true,
        "patientFullName": "sample string 12",
        "patientUuid": "sample string 13",
        "procedureDescription": "sample string 14",
        "procedureModality": "sample string 15",
        "studyUID": 16,
        "snapshotOwner": "sample string 17",
        "snapshotOwnerUserName": "sample string 18",
        "birthDate": "2025-12-15T04:58:46",
        "displayTimestamp": "2025-12-15T04:58:46",
        "studyCompletionDate": "2025-12-15T04:58:46",
        "studyStatusCD": 1,
        "studyStatus": "sample string 19",
        "priority": "sample string 20",
        "studyImageCount": 1,
        "lastModifiedTimestamp": "2025-12-15T04:58:46",
        "reportStatusCode": 1,
        "totalNumberNote": 1,
        "totalNumberDoc": 1,
        "lastViewedTime": "2025-12-15T04:58:46",
        "displayStateFlag": 1,
        "procedureModifier": "sample string 21",
        "facilityCode": "sample string 22",
        "medicalCheckupCourseNo": "sample string 23",
        "medicalCheckupNo": "sample string 24",
        "reason": "sample string 25"
      }
    }
  ],
  "UserLogin": "sample string 2"
}

application/xml, text/xml

Sample: 
<LinkFolderAddItemsParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Worklists">
  <Items>
    <LinkFolderItem>
      <DataSourceUuid>sample string 3</DataSourceUuid>
      <Identifier>sample string 1</Identifier>
      <IsDisplayState>true</IsDisplayState>
      <IsRemoteStudy>true</IsRemoteStudy>
      <RemoteItemInfo>
        <accessionNumber>sample string 1</accessionNumber>
        <addedBy>sample string 2</addedBy>
        <birthDate>2025-12-15T04:58:46.5601697-06:00</birthDate>
        <dataSource>sample string 3</dataSource>
        <dataSourceType>4</dataSourceType>
        <dicomSrUid>1</dicomSrUid>
        <displayStateFlag>1</displayStateFlag>
        <displayStateName>sample string 5</displayStateName>
        <displayTimestamp>2025-12-15T04:58:46.5601697-06:00</displayTimestamp>
        <facilityCode>sample string 22</facilityCode>
        <hasARReportInstance>sample string 6</hasARReportInstance>
        <identifier>sample string 7</identifier>
        <instanceEUID>sample string 8</instanceEUID>
        <internalPatientUID>sample string 9</internalPatientUID>
        <isValidForAR>true</isValidForAR>
        <isValidForArReport>true</isValidForArReport>
        <lastModifiedTimestamp>2025-12-15T04:58:46.5601697-06:00</lastModifiedTimestamp>
        <lastViewedTime>2025-12-15T04:58:46.5601697-06:00</lastViewedTime>
        <medicalCheckupCourseNo>sample string 23</medicalCheckupCourseNo>
        <medicalCheckupNo>sample string 24</medicalCheckupNo>
        <patientFullName>sample string 12</patientFullName>
        <patientUuid>sample string 13</patientUuid>
        <priority>sample string 20</priority>
        <procedureDescription>sample string 14</procedureDescription>
        <procedureModality>sample string 15</procedureModality>
        <procedureModifier>sample string 21</procedureModifier>
        <reason>sample string 25</reason>
        <reportStatusCode>1</reportStatusCode>
        <snapshotOwner>sample string 17</snapshotOwner>
        <snapshotOwnerUserName>sample string 18</snapshotOwnerUserName>
        <studyCompletionDate>2025-12-15T04:58:46.5601697-06:00</studyCompletionDate>
        <studyImageCount>1</studyImageCount>
        <studyStatus>sample string 19</studyStatus>
        <studyStatusCD>1</studyStatusCD>
        <studyUID>16</studyUID>
        <totalNumberDoc>1</totalNumberDoc>
        <totalNumberNote>1</totalNumberNote>
      </RemoteItemInfo>
    </LinkFolderItem>
    <LinkFolderItem>
      <DataSourceUuid>sample string 3</DataSourceUuid>
      <Identifier>sample string 1</Identifier>
      <IsDisplayState>true</IsDisplayState>
      <IsRemoteStudy>true</IsRemoteStudy>
      <RemoteItemInfo>
        <accessionNumber>sample string 1</accessionNumber>
        <addedBy>sample string 2</addedBy>
        <birthDate>2025-12-15T04:58:46.5601697-06:00</birthDate>
        <dataSource>sample string 3</dataSource>
        <dataSourceType>4</dataSourceType>
        <dicomSrUid>1</dicomSrUid>
        <displayStateFlag>1</displayStateFlag>
        <displayStateName>sample string 5</displayStateName>
        <displayTimestamp>2025-12-15T04:58:46.5601697-06:00</displayTimestamp>
        <facilityCode>sample string 22</facilityCode>
        <hasARReportInstance>sample string 6</hasARReportInstance>
        <identifier>sample string 7</identifier>
        <instanceEUID>sample string 8</instanceEUID>
        <internalPatientUID>sample string 9</internalPatientUID>
        <isValidForAR>true</isValidForAR>
        <isValidForArReport>true</isValidForArReport>
        <lastModifiedTimestamp>2025-12-15T04:58:46.5601697-06:00</lastModifiedTimestamp>
        <lastViewedTime>2025-12-15T04:58:46.5601697-06:00</lastViewedTime>
        <medicalCheckupCourseNo>sample string 23</medicalCheckupCourseNo>
        <medicalCheckupNo>sample string 24</medicalCheckupNo>
        <patientFullName>sample string 12</patientFullName>
        <patientUuid>sample string 13</patientUuid>
        <priority>sample string 20</priority>
        <procedureDescription>sample string 14</procedureDescription>
        <procedureModality>sample string 15</procedureModality>
        <procedureModifier>sample string 21</procedureModifier>
        <reason>sample string 25</reason>
        <reportStatusCode>1</reportStatusCode>
        <snapshotOwner>sample string 17</snapshotOwner>
        <snapshotOwnerUserName>sample string 18</snapshotOwnerUserName>
        <studyCompletionDate>2025-12-15T04:58:46.5601697-06:00</studyCompletionDate>
        <studyImageCount>1</studyImageCount>
        <studyStatus>sample string 19</studyStatus>
        <studyStatusCD>1</studyStatusCD>
        <studyUID>16</studyUID>
        <totalNumberDoc>1</totalNumberDoc>
        <totalNumberNote>1</totalNumberNote>
      </RemoteItemInfo>
    </LinkFolderItem>
  </Items>
  <LinkFolderUuid>sample string 1</LinkFolderUuid>
  <UserLogin>sample string 2</UserLogin>
</LinkFolderAddItemsParams>

Response Information

Resource Description

AddItemstoLinkFolderResult
NameDescriptionTypeAdditional information
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: 
{
  "Succeeded": true,
  "Remarks": "sample string 2"
}

application/xml, text/xml

Sample: 
<AddItemstoLinkFolderResult 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 2</Remarks>
  <Succeeded>true</Succeeded>
</AddItemstoLinkFolderResult>