POST api/v2.0/ExternalSearch/AddLibraryEntryItems

Add External Library Items to the Search Results.

Request Information

URI Parameters

None.

Body Parameters

External Library Items to add.

Name	Type	Additional information
ContributorLegacyContactKey	string	None.
Additional	Collection of string	None.
AuthorName	string	None.
Code	string	None.
CreatedOn	date	None.
Description	string	None.
Files	Collection of LinkInfo	None.
ID	string	None.
Isbn	string	None.
IsDelete	boolean	None.
Issue	string	None.
PageCount	integer	None.
PublicationDate	date	None.
Publisher	string	None.
Tags	Collection of TagInfo	None.
Title	string	None.
Url	string	None.
ViewSecurityRoles	Collection of string	None.
Volume	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "ContributorLegacyContactKey": "sample string 1",
    "Additional": [
      "sample string 1",
      "sample string 2"
    ],
    "AuthorName": "sample string 2",
    "Code": "sample string 3",
    "CreatedOn": "2024-12-26T10:41:43.7786735Z",
    "Description": "sample string 5",
    "Files": [
      {
        "Text": "sample string 1",
        "Url": "sample string 2"
      },
      {
        "Text": "sample string 1",
        "Url": "sample string 2"
      }
    ],
    "ID": "sample string 6",
    "Isbn": "sample string 7",
    "IsDelete": true,
    "Issue": "sample string 9",
    "PageCount": 10,
    "PublicationDate": "2024-12-26T10:41:43.7786735Z",
    "Publisher": "sample string 12",
    "Tags": [
      {
        "Tag": "sample string 1",
        "TagGroup": "sample string 2"
      },
      {
        "Tag": "sample string 1",
        "TagGroup": "sample string 2"
      }
    ],
    "Title": "sample string 13",
    "Url": "sample string 14",
    "ViewSecurityRoles": [
      "sample string 1",
      "sample string 2"
    ],
    "Volume": "sample string 15"
  },
  {
    "ContributorLegacyContactKey": "sample string 1",
    "Additional": [
      "sample string 1",
      "sample string 2"
    ],
    "AuthorName": "sample string 2",
    "Code": "sample string 3",
    "CreatedOn": "2024-12-26T10:41:43.7786735Z",
    "Description": "sample string 5",
    "Files": [
      {
        "Text": "sample string 1",
        "Url": "sample string 2"
      },
      {
        "Text": "sample string 1",
        "Url": "sample string 2"
      }
    ],
    "ID": "sample string 6",
    "Isbn": "sample string 7",
    "IsDelete": true,
    "Issue": "sample string 9",
    "PageCount": 10,
    "PublicationDate": "2024-12-26T10:41:43.7786735Z",
    "Publisher": "sample string 12",
    "Tags": [
      {
        "Tag": "sample string 1",
        "TagGroup": "sample string 2"
      },
      {
        "Tag": "sample string 1",
        "TagGroup": "sample string 2"
      }
    ],
    "Title": "sample string 13",
    "Url": "sample string 14",
    "ViewSecurityRoles": [
      "sample string 1",
      "sample string 2"
    ],
    "Volume": "sample string 15"
  }
]

application/xml, text/xml

Sample:

<ArrayOfExternalSearchItem.ExternalLibraryEntry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.Business.Core">
  <ExternalSearchItem.ExternalLibraryEntry>
    <_x003C_Additional_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </_x003C_Additional_x003E_k__BackingField>
    <_x003C_AuthorName_x003E_k__BackingField>sample string 2</_x003C_AuthorName_x003E_k__BackingField>
    <_x003C_Code_x003E_k__BackingField>sample string 3</_x003C_Code_x003E_k__BackingField>
    <_x003C_ContributorLegacyContactKey_x003E_k__BackingField>sample string 1</_x003C_ContributorLegacyContactKey_x003E_k__BackingField>
    <_x003C_CreatedOn_x003E_k__BackingField>2024-12-26T05:41:43.7786735-05:00</_x003C_CreatedOn_x003E_k__BackingField>
    <_x003C_Description_x003E_k__BackingField>sample string 5</_x003C_Description_x003E_k__BackingField>
    <_x003C_Files_x003E_k__BackingField>
      <ExternalSearchItem.LinkInfo>
        <_x003C_Text_x003E_k__BackingField>sample string 1</_x003C_Text_x003E_k__BackingField>
        <_x003C_Url_x003E_k__BackingField>sample string 2</_x003C_Url_x003E_k__BackingField>
      </ExternalSearchItem.LinkInfo>
      <ExternalSearchItem.LinkInfo>
        <_x003C_Text_x003E_k__BackingField>sample string 1</_x003C_Text_x003E_k__BackingField>
        <_x003C_Url_x003E_k__BackingField>sample string 2</_x003C_Url_x003E_k__BackingField>
      </ExternalSearchItem.LinkInfo>
    </_x003C_Files_x003E_k__BackingField>
    <_x003C_ID_x003E_k__BackingField>sample string 6</_x003C_ID_x003E_k__BackingField>
    <_x003C_IsDelete_x003E_k__BackingField>true</_x003C_IsDelete_x003E_k__BackingField>
    <_x003C_Isbn_x003E_k__BackingField>sample string 7</_x003C_Isbn_x003E_k__BackingField>
    <_x003C_Issue_x003E_k__BackingField>sample string 9</_x003C_Issue_x003E_k__BackingField>
    <_x003C_PageCount_x003E_k__BackingField>10</_x003C_PageCount_x003E_k__BackingField>
    <_x003C_PublicationDate_x003E_k__BackingField>2024-12-26T05:41:43.7786735-05:00</_x003C_PublicationDate_x003E_k__BackingField>
    <_x003C_Publisher_x003E_k__BackingField>sample string 12</_x003C_Publisher_x003E_k__BackingField>
    <_x003C_Tags_x003E_k__BackingField>
      <ExternalSearchItem.TagInfo>
        <_x003C_TagGroup_x003E_k__BackingField>sample string 2</_x003C_TagGroup_x003E_k__BackingField>
        <_x003C_Tag_x003E_k__BackingField>sample string 1</_x003C_Tag_x003E_k__BackingField>
      </ExternalSearchItem.TagInfo>
      <ExternalSearchItem.TagInfo>
        <_x003C_TagGroup_x003E_k__BackingField>sample string 2</_x003C_TagGroup_x003E_k__BackingField>
        <_x003C_Tag_x003E_k__BackingField>sample string 1</_x003C_Tag_x003E_k__BackingField>
      </ExternalSearchItem.TagInfo>
    </_x003C_Tags_x003E_k__BackingField>
    <_x003C_Title_x003E_k__BackingField>sample string 13</_x003C_Title_x003E_k__BackingField>
    <_x003C_Url_x003E_k__BackingField>sample string 14</_x003C_Url_x003E_k__BackingField>
    <_x003C_ViewSecurityRoles_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </_x003C_ViewSecurityRoles_x003E_k__BackingField>
    <_x003C_Volume_x003E_k__BackingField>sample string 15</_x003C_Volume_x003E_k__BackingField>
  </ExternalSearchItem.ExternalLibraryEntry>
  <ExternalSearchItem.ExternalLibraryEntry>
    <_x003C_Additional_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </_x003C_Additional_x003E_k__BackingField>
    <_x003C_AuthorName_x003E_k__BackingField>sample string 2</_x003C_AuthorName_x003E_k__BackingField>
    <_x003C_Code_x003E_k__BackingField>sample string 3</_x003C_Code_x003E_k__BackingField>
    <_x003C_ContributorLegacyContactKey_x003E_k__BackingField>sample string 1</_x003C_ContributorLegacyContactKey_x003E_k__BackingField>
    <_x003C_CreatedOn_x003E_k__BackingField>2024-12-26T05:41:43.7786735-05:00</_x003C_CreatedOn_x003E_k__BackingField>
    <_x003C_Description_x003E_k__BackingField>sample string 5</_x003C_Description_x003E_k__BackingField>
    <_x003C_Files_x003E_k__BackingField>
      <ExternalSearchItem.LinkInfo>
        <_x003C_Text_x003E_k__BackingField>sample string 1</_x003C_Text_x003E_k__BackingField>
        <_x003C_Url_x003E_k__BackingField>sample string 2</_x003C_Url_x003E_k__BackingField>
      </ExternalSearchItem.LinkInfo>
      <ExternalSearchItem.LinkInfo>
        <_x003C_Text_x003E_k__BackingField>sample string 1</_x003C_Text_x003E_k__BackingField>
        <_x003C_Url_x003E_k__BackingField>sample string 2</_x003C_Url_x003E_k__BackingField>
      </ExternalSearchItem.LinkInfo>
    </_x003C_Files_x003E_k__BackingField>
    <_x003C_ID_x003E_k__BackingField>sample string 6</_x003C_ID_x003E_k__BackingField>
    <_x003C_IsDelete_x003E_k__BackingField>true</_x003C_IsDelete_x003E_k__BackingField>
    <_x003C_Isbn_x003E_k__BackingField>sample string 7</_x003C_Isbn_x003E_k__BackingField>
    <_x003C_Issue_x003E_k__BackingField>sample string 9</_x003C_Issue_x003E_k__BackingField>
    <_x003C_PageCount_x003E_k__BackingField>10</_x003C_PageCount_x003E_k__BackingField>
    <_x003C_PublicationDate_x003E_k__BackingField>2024-12-26T05:41:43.7786735-05:00</_x003C_PublicationDate_x003E_k__BackingField>
    <_x003C_Publisher_x003E_k__BackingField>sample string 12</_x003C_Publisher_x003E_k__BackingField>
    <_x003C_Tags_x003E_k__BackingField>
      <ExternalSearchItem.TagInfo>
        <_x003C_TagGroup_x003E_k__BackingField>sample string 2</_x003C_TagGroup_x003E_k__BackingField>
        <_x003C_Tag_x003E_k__BackingField>sample string 1</_x003C_Tag_x003E_k__BackingField>
      </ExternalSearchItem.TagInfo>
      <ExternalSearchItem.TagInfo>
        <_x003C_TagGroup_x003E_k__BackingField>sample string 2</_x003C_TagGroup_x003E_k__BackingField>
        <_x003C_Tag_x003E_k__BackingField>sample string 1</_x003C_Tag_x003E_k__BackingField>
      </ExternalSearchItem.TagInfo>
    </_x003C_Tags_x003E_k__BackingField>
    <_x003C_Title_x003E_k__BackingField>sample string 13</_x003C_Title_x003E_k__BackingField>
    <_x003C_Url_x003E_k__BackingField>sample string 14</_x003C_Url_x003E_k__BackingField>
    <_x003C_ViewSecurityRoles_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </_x003C_ViewSecurityRoles_x003E_k__BackingField>
    <_x003C_Volume_x003E_k__BackingField>sample string 15</_x003C_Volume_x003E_k__BackingField>
  </ExternalSearchItem.ExternalLibraryEntry>
</ArrayOfExternalSearchItem.ExternalLibraryEntry>

Response Information

Resource Description

AddItemsResponse

Name	Description	Type	Additional information
QueuedIdList	List of IDs that have been successfully accepted for index queuing within the Community site.	Collection of string	None.
Errors	List of Errors that occurred when attempting to queue the passed in External Search items.	Collection of ItemError	None.

Response Formats

application/json, text/json

Sample:

{
  "QueuedIdList": [
    "sample string 1",
    "sample string 2"
  ],
  "Errors": [
    {
      "ErrorMessage": "sample string 1",
      "Item": "sample string 2"
    },
    {
      "ErrorMessage": "sample string 1",
      "Item": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<AddItemsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.ExternalSearch">
  <Errors>
    <ItemError>
      <ErrorMessage>sample string 1</ErrorMessage>
      <Item>sample string 2</Item>
    </ItemError>
    <ItemError>
      <ErrorMessage>sample string 1</ErrorMessage>
      <Item>sample string 2</Item>
    </ItemError>
  </Errors>
  <QueuedIdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </QueuedIdList>
</AddItemsResponse>