Get Publish Group REST Endpoint

GET api.ashx/v2/articles/publishgroup/{id}.{json|xml}

Scopes

Article Collections › Read Publish Groups articlecollections.publishgroups.readonly

Request Parameters

Name Type Location Description Required Default Options
Id int Query String Id of the publish group to return. Required

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/articles/publishgroup/{id}.json',
	data: { 
		'id': '6'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "PublishGroups": [
    {
      "Id": 6,
      "Name": "name",
      "ArticleCollection": {
        "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e",
        "EnableHelpfulness": true,
        "Name": "name",
        "UrlKey": "urlkey",
        "Description": "description",
        "CreateDate": null,
        "Group": {
          "AvatarUrl": "avatarurl",
          "DateCreated": "2012-01-04T00:00:00",
          "Description": "description",
          "Key": "key",
          "Name": "name",
          "ParentGroupId": 25,
          "Url": "url",
          "TotalMembers": 8,
          "HasGroups": true,
          "GroupCount": 4,
          "GroupType": "grouptype",
          "EnableGroupMessages": true,
          "EnableContact": true,
          "SearchUniqueId": "searchuniqueid",
          "IsEnabled": true,
          "ExtendedAttributes": [
            {
              "Key": "key",
              "Value": "value"
            },
            {
              "Key": "key",
              "Value": "value"
            }
          ],
          "ContainerId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
          "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
          "Container": {
            "ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff",
            "ContainerTypeId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
            "HtmlName": "htmlname",
            "Url": "url",
            "AvatarUrl": "avatarurl"
          },
          "Id": 7
        },
        "Url": "url",
        "CreatedBy": {
          "AvatarUrl": "avatarurl",
          "DisplayName": "displayname",
          "ProfileUrl": "profileurl",
          "Username": "username",
          "CurrentStatus": {
            "Author": {
              "AvatarUrl": "avatarurl",
              "DisplayName": "displayname",
              "ProfileUrl": "profileurl",
              "Username": "username",
              "CurrentStatus": null,
              "Id": null
            },
            "Body": "body",
            "CreatedDate": "2012-05-02T00:00:00",
            "ReplyCount": 27,
            "Group": {
              "AvatarUrl": "avatarurl",
              "DateCreated": null,
              "Description": "description",
              "Key": "key",
              "Name": "name",
              "Url": "url",
              "TotalMembers": null,
              "HasGroups": true,
              "GroupCount": null,
              "GroupType": "grouptype",
              "EnableGroupMessages": true,
              "EnableContact": true,
              "SearchUniqueId": "searchuniqueid",
              "IsEnabled": true,
              "ExtendedAttributes": [],
              "ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
              "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
              "Container": null,
              "Id": null
            },
            "AttachedUrl": "attachedurl",
            "HasReplies": true,
            "ContentId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
            "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
            "Url": "url",
            "IsPublished": true,
            "Content": {
              "CreatedByUser": null,
              "ContentId": "6cdcf200-3bad-476d-af45-97b52545c337",
              "ContentTypeId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
              "CreatedDate": "2012-06-04T00:00:00",
              "HtmlName": "htmlname",
              "HtmlDescription": "htmldescription",
              "Url": "url",
              "AvatarUrl": "avatarurl",
              "Application": null
            },
            "Id": "44df201a-07e6-42eb-96c7-8ce7ce35aab6"
          },
          "Id": 32
        },
        "Prefix": "prefix",
        "DefaultType": {
          "Id": 52,
          "Name": "name",
          "ImageUrl": "imageurl"
        },
        "DefaultArticleId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
        "ThemeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46"
      },
      "CreateDate": "2011-05-28T00:00:00",
      "PublishDate": "2011-12-09T00:00:00",
      "PublishEndDate": "2012-03-29T00:00:00",
      "IsPublished": true,
      "IsDeleted": true,
      "DeleteDate": "2012-04-19T00:00:00",
      "PublishedVersionCount": 19,
      "UnpublishedVersionCount": 112
    },
    {
      "Id": 61,
      "Name": "name",
      "ArticleCollection": {
        "Id": "fe65240b-044c-4292-9946-f10e0361ecff",
        "EnableHelpfulness": true,
        "Name": "name",
        "UrlKey": "urlkey",
        "Description": "description",
        "CreateDate": null,
        "Group": {
          "AvatarUrl": "avatarurl",
          "DateCreated": "2012-01-16T00:00:00",
          "Description": "description",
          "Key": "key",
          "Name": "name",
          "ParentGroupId": 18,
          "Url": "url",
          "TotalMembers": 76,
          "HasGroups": true,
          "GroupCount": 6,
          "GroupType": "grouptype",
          "EnableGroupMessages": true,
          "EnableContact": true,
          "SearchUniqueId": "searchuniqueid",
          "IsEnabled": true,
          "ExtendedAttributes": [
            {
              "Key": "key",
              "Value": "value"
            },
            {
              "Key": "key",
              "Value": "value"
            }
          ],
          "ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
          "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
          "Container": {
            "ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
            "ContainerTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
            "HtmlName": "htmlname",
            "Url": "url",
            "AvatarUrl": "avatarurl"
          },
          "Id": 25
        },
        "Url": "url",
        "CreatedBy": {
          "AvatarUrl": "avatarurl",
          "DisplayName": "displayname",
          "ProfileUrl": "profileurl",
          "Username": "username",
          "CurrentStatus": {
            "Author": {
              "AvatarUrl": "avatarurl",
              "DisplayName": "displayname",
              "ProfileUrl": "profileurl",
              "Username": "username",
              "CurrentStatus": null,
              "Id": null
            },
            "Body": "body",
            "CreatedDate": "2012-01-04T00:00:00",
            "ReplyCount": 8,
            "Group": {
              "AvatarUrl": "avatarurl",
              "DateCreated": null,
              "Description": "description",
              "Key": "key",
              "Name": "name",
              "Url": "url",
              "TotalMembers": null,
              "HasGroups": true,
              "GroupCount": null,
              "GroupType": "grouptype",
              "EnableGroupMessages": true,
              "EnableContact": true,
              "SearchUniqueId": "searchuniqueid",
              "IsEnabled": true,
              "ExtendedAttributes": [],
              "ContainerId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
              "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
              "Container": null,
              "Id": null
            },
            "AttachedUrl": "attachedurl",
            "HasReplies": true,
            "ContentId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
            "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
            "Url": "url",
            "IsPublished": true,
            "Content": {
              "CreatedByUser": null,
              "ContentId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
              "ContentTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
              "CreatedDate": "2012-05-02T00:00:00",
              "HtmlName": "htmlname",
              "HtmlDescription": "htmldescription",
              "Url": "url",
              "AvatarUrl": "avatarurl",
              "Application": null
            },
            "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46"
          },
          "Id": 4
        },
        "Prefix": "prefix",
        "DefaultType": {
          "Id": 7,
          "Name": "name",
          "ImageUrl": "imageurl"
        },
        "DefaultArticleId": "fe65240b-044c-4292-9946-f10e0361ecff",
        "ThemeId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e"
      },
      "CreateDate": "2012-06-04T00:00:00",
      "PublishDate": "2011-05-28T00:00:00",
      "PublishEndDate": "2011-12-09T00:00:00",
      "IsPublished": true,
      "IsDeleted": true,
      "DeleteDate": "2012-03-29T00:00:00",
      "PublishedVersionCount": 27,
      "UnpublishedVersionCount": 32
    }
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <PublishGroups>
    <PublishGroup>
      <Id>6</Id>
      <Name>name</Name>
      <ArticleCollection>
        <Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
        <EnableHelpfulness>true</EnableHelpfulness>
        <Name>name</Name>
        <UrlKey>urlkey</UrlKey>
        <Description>description</Description>
        <Group>
          <Id>7</Id>
          <AvatarUrl>avatarurl</AvatarUrl>
          <DateCreated>2012-01-04T00:00:00</DateCreated>
          <Description>description</Description>
          <Key>key</Key>
          <Name>name</Name>
          <ParentGroupId>25</ParentGroupId>
          <Url>url</Url>
          <TotalMembers>8</TotalMembers>
          <HasGroups>true</HasGroups>
          <GroupCount>4</GroupCount>
          <GroupType>grouptype</GroupType>
          <EnableGroupMessages>true</EnableGroupMessages>
          <EnableContact>true</EnableContact>
          <SearchUniqueId>searchuniqueid</SearchUniqueId>
          <ExtendedAttributes>
            <key>value</key>
            <key>value</key>
          </ExtendedAttributes>
          <ContainerId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId>
          <Container>
            <ContainerId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerId>
            <ContainerTypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerTypeId>
            <HtmlName>htmlname</HtmlName>
            <Url>url</Url>
            <AvatarUrl>avatarurl</AvatarUrl>
          </Container>
        </Group>
        <Url>url</Url>
        <CreatedBy>
          <Id>32</Id>
          <AvatarUrl>avatarurl</AvatarUrl>
          <DisplayName>displayname</DisplayName>
          <ProfileUrl>profileurl</ProfileUrl>
          <Username>username</Username>
          <CurrentStatus>
            <Id>44df201a-07e6-42eb-96c7-8ce7ce35aab6</Id>
            <Author>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DisplayName>displayname</DisplayName>
              <ProfileUrl>profileurl</ProfileUrl>
              <Username>username</Username>
            </Author>
            <Body>body</Body>
            <CreatedDate>2012-05-02T00:00:00</CreatedDate>
            <ReplyCount>27</ReplyCount>
            <Group>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DateCreated />
              <Description>description</Description>
              <Key>key</Key>
              <Name>name</Name>
              <Url>url</Url>
              <TotalMembers />
              <HasGroups>true</HasGroups>
              <GroupCount />
              <GroupType>grouptype</GroupType>
              <EnableGroupMessages>true</EnableGroupMessages>
              <EnableContact>true</EnableContact>
              <SearchUniqueId>searchuniqueid</SearchUniqueId>
              <ExtendedAttributes />
              <ContainerId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerId>
            </Group>
            <AttachedUrl>attachedurl</AttachedUrl>
            <ContentId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContentId>
            <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
            <Url>url</Url>
            <IsPublished>true</IsPublished>
            <Content>
              <ContentId>6cdcf200-3bad-476d-af45-97b52545c337</ContentId>
              <ContentTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContentTypeId>
              <CreatedDate>2012-06-04T00:00:00</CreatedDate>
              <HtmlName>htmlname</HtmlName>
              <HtmlDescription>htmldescription</HtmlDescription>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Content>
          </CurrentStatus>
        </CreatedBy>
        <Prefix>prefix</Prefix>
        <DefaultType>
          <Id>52</Id>
          <Name>name</Name>
          <ImageUrl>imageurl</ImageUrl>
        </DefaultType>
        <DefaultArticleId>49fec544-6df7-4a82-872b-f8be586d5e9e</DefaultArticleId>
        <ThemeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ThemeId>
      </ArticleCollection>
      <CreateDate>2011-05-28T00:00:00</CreateDate>
      <PublishDate>2011-12-09T00:00:00</PublishDate>
      <PublishEndDate>2012-03-29T00:00:00</PublishEndDate>
      <IsPublished>true</IsPublished>
      <IsDeleted>true</IsDeleted>
      <DeleteDate>2012-04-19T00:00:00</DeleteDate>
      <PublishedVersionCount>19</PublishedVersionCount>
      <UnpublishedVersionCount>112</UnpublishedVersionCount>
    </PublishGroup>
    <PublishGroup>
      <Id>61</Id>
      <Name>name</Name>
      <ArticleCollection>
        <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id>
        <EnableHelpfulness>true</EnableHelpfulness>
        <Name>name</Name>
        <UrlKey>urlkey</UrlKey>
        <Description>description</Description>
        <Group>
          <Id>25</Id>
          <AvatarUrl>avatarurl</AvatarUrl>
          <DateCreated>2012-01-16T00:00:00</DateCreated>
          <Description>description</Description>
          <Key>key</Key>
          <Name>name</Name>
          <ParentGroupId>18</ParentGroupId>
          <Url>url</Url>
          <TotalMembers>76</TotalMembers>
          <HasGroups>true</HasGroups>
          <GroupCount>6</GroupCount>
          <GroupType>grouptype</GroupType>
          <EnableGroupMessages>true</EnableGroupMessages>
          <EnableContact>true</EnableContact>
          <SearchUniqueId>searchuniqueid</SearchUniqueId>
          <ExtendedAttributes>
            <key>value</key>
            <key>value</key>
          </ExtendedAttributes>
          <ContainerId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerId>
          <Container>
            <ContainerId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerId>
            <ContainerTypeId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerTypeId>
            <HtmlName>htmlname</HtmlName>
            <Url>url</Url>
            <AvatarUrl>avatarurl</AvatarUrl>
          </Container>
        </Group>
        <Url>url</Url>
        <CreatedBy>
          <Id>4</Id>
          <AvatarUrl>avatarurl</AvatarUrl>
          <DisplayName>displayname</DisplayName>
          <ProfileUrl>profileurl</ProfileUrl>
          <Username>username</Username>
          <CurrentStatus>
            <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id>
            <Author>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DisplayName>displayname</DisplayName>
              <ProfileUrl>profileurl</ProfileUrl>
              <Username>username</Username>
            </Author>
            <Body>body</Body>
            <CreatedDate>2012-01-04T00:00:00</CreatedDate>
            <ReplyCount>8</ReplyCount>
            <Group>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DateCreated />
              <Description>description</Description>
              <Key>key</Key>
              <Name>name</Name>
              <Url>url</Url>
              <TotalMembers />
              <HasGroups>true</HasGroups>
              <GroupCount />
              <GroupType>grouptype</GroupType>
              <EnableGroupMessages>true</EnableGroupMessages>
              <EnableContact>true</EnableContact>
              <SearchUniqueId>searchuniqueid</SearchUniqueId>
              <ExtendedAttributes />
              <ContainerId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerId>
            </Group>
            <AttachedUrl>attachedurl</AttachedUrl>
            <ContentId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContentId>
            <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
            <Url>url</Url>
            <IsPublished>true</IsPublished>
            <Content>
              <ContentId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContentId>
              <ContentTypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentTypeId>
              <CreatedDate>2012-05-02T00:00:00</CreatedDate>
              <HtmlName>htmlname</HtmlName>
              <HtmlDescription>htmldescription</HtmlDescription>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Content>
          </CurrentStatus>
        </CreatedBy>
        <Prefix>prefix</Prefix>
        <DefaultType>
          <Id>7</Id>
          <Name>name</Name>
          <ImageUrl>imageurl</ImageUrl>
        </DefaultType>
        <DefaultArticleId>fe65240b-044c-4292-9946-f10e0361ecff</DefaultArticleId>
        <ThemeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ThemeId>
      </ArticleCollection>
      <CreateDate>2012-06-04T00:00:00</CreateDate>
      <PublishDate>2011-05-28T00:00:00</PublishDate>
      <PublishEndDate>2011-12-09T00:00:00</PublishEndDate>
      <IsPublished>true</IsPublished>
      <IsDeleted>true</IsDeleted>
      <DeleteDate>2012-03-29T00:00:00</DeleteDate>
      <PublishedVersionCount>27</PublishedVersionCount>
      <UnpublishedVersionCount>32</UnpublishedVersionCount>
    </PublishGroup>
  </PublishGroups>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>
Related
Recommended

About
Privacy Policy
Terms of use
Copyright 2024 Verint, Inc.
Powered by Verint Community