GET v1/resources/{resourceId}

Get details about a particular resource

Request Information

URI Parameters

Name	Description	Type	Additional information
resourceId	Resource Id for the resource you want to retrieve	integer	Required

Body Parameters

None.

Response Information

Resource Description

ResourceDetailsModel

Name	Description	Type	Additional information
Views	Number of pageviews this resource has received across all communities	integer	None.
Favorites	Number of favorites this resource has received across all communities	integer	None.
DNA		Collection of FlatTagModel	None.
Communities		Collection of ResourceCommunityDetailsModel	None.
ResourceId		integer	None.
Title		string	None.
GroupId	Group Id if this resource is posted into a group	integer	None.
SessionId	Session Id if this resource is tied to an event session	integer	None.
ResourceType		ResourceType	None.
AuthorDisplayType	Who posted this resource	ResourceAuthorDisplayType	None.
Status		ResourceStatus	None.
Privacy		ResourcePrivacy	None.
Description		string	None.
DatePublished		date	None.
DateAvailable		date	None.
DateExpires		date	None.
TimeZone		string	None.
Communities		Collection of ResourceCommunityModel	None.
CreatedByUserId	Id of the user who posted this resource	integer	None.
OrganizationId	Id for organization who posted this resource	integer	None.
NumberOfAttachments	The number of attachments for this resource	integer	None.
OrganizationName		string	None.
DisableComments		boolean	None.
CoverPhotoUrl		string	None.
FileUrl	Url to file for audio or document resources	string	None.

Try API

Try this endpoint by entering your credentials and using the API Explorer.

Try With API Explorer

Response Formats

application/json, text/json

Sample:

{
  "Views": 1,
  "Favorites": 2,
  "DNA": [
    {
      "TagId": 1,
      "Name": "sample string 2",
      "ParentTagId": 1,
      "TagSetId": 3,
      "TagSetName": "sample string 4",
      "CommunityId": 5,
      "CommunityName": "sample string 6"
    },
    {
      "TagId": 1,
      "Name": "sample string 2",
      "ParentTagId": 1,
      "TagSetId": 3,
      "TagSetName": "sample string 4",
      "CommunityId": 5,
      "CommunityName": "sample string 6"
    }
  ],
  "Communities": [
    {
      "Comments": [
        {
          "CommentId": 1,
          "ParentCommentId": 1,
          "UserId": 2,
          "Message": "sample string 3",
          "DatePosted": "2024-05-17T10:42:48.730029Z",
          "Status": "Published",
          "FirstName": "sample string 5",
          "LastName": "sample string 6",
          "Anonymous": true,
          "Alias": "sample string 12",
          "UserProfileUrl": "https://sample string 2.causemachine.com/members/sample string 13",
          "UserPictureUrl": "https://sample string 2.causemachine.com/content/images/avatars/sample string 14",
          "DisplayName": "sample string 12",
          "CommunityId": 15,
          "CommunityName": "sample string 16"
        },
        {
          "CommentId": 1,
          "ParentCommentId": 1,
          "UserId": 2,
          "Message": "sample string 3",
          "DatePosted": "2024-05-17T10:42:48.730029Z",
          "Status": "Published",
          "FirstName": "sample string 5",
          "LastName": "sample string 6",
          "Anonymous": true,
          "Alias": "sample string 12",
          "UserProfileUrl": "https://sample string 2.causemachine.com/members/sample string 13",
          "UserPictureUrl": "https://sample string 2.causemachine.com/content/images/avatars/sample string 14",
          "DisplayName": "sample string 12",
          "CommunityId": 15,
          "CommunityName": "sample string 16"
        }
      ],
      "Views": 1,
      "Status": "Draft",
      "ResourceUrl": "https://sample string 2.causemachine.com/resources/2/sample string 3",
      "Author": "sample string 15",
      "AuthorImageUrl": "https://sample string 2.causemachine.com/content/images/avatars/sample string 14",
      "AuthorProfileUrl": "https://sample string 2.causemachine.com/members/sample string 17",
      "CommunityId": 18,
      "CommunityName": "sample string 19"
    },
    {
      "Comments": [
        {
          "CommentId": 1,
          "ParentCommentId": 1,
          "UserId": 2,
          "Message": "sample string 3",
          "DatePosted": "2024-05-17T10:42:48.730029Z",
          "Status": "Published",
          "FirstName": "sample string 5",
          "LastName": "sample string 6",
          "Anonymous": true,
          "Alias": "sample string 12",
          "UserProfileUrl": "https://sample string 2.causemachine.com/members/sample string 13",
          "UserPictureUrl": "https://sample string 2.causemachine.com/content/images/avatars/sample string 14",
          "DisplayName": "sample string 12",
          "CommunityId": 15,
          "CommunityName": "sample string 16"
        },
        {
          "CommentId": 1,
          "ParentCommentId": 1,
          "UserId": 2,
          "Message": "sample string 3",
          "DatePosted": "2024-05-17T10:42:48.730029Z",
          "Status": "Published",
          "FirstName": "sample string 5",
          "LastName": "sample string 6",
          "Anonymous": true,
          "Alias": "sample string 12",
          "UserProfileUrl": "https://sample string 2.causemachine.com/members/sample string 13",
          "UserPictureUrl": "https://sample string 2.causemachine.com/content/images/avatars/sample string 14",
          "DisplayName": "sample string 12",
          "CommunityId": 15,
          "CommunityName": "sample string 16"
        }
      ],
      "Views": 1,
      "Status": "Draft",
      "ResourceUrl": "https://sample string 2.causemachine.com/resources/2/sample string 3",
      "Author": "sample string 15",
      "AuthorImageUrl": "https://sample string 2.causemachine.com/content/images/avatars/sample string 14",
      "AuthorProfileUrl": "https://sample string 2.causemachine.com/members/sample string 17",
      "CommunityId": 18,
      "CommunityName": "sample string 19"
    }
  ],
  "ResourceId": 3,
  "Title": "sample string 4",
  "GroupId": 1,
  "SessionId": 1,
  "ResourceType": "Audio",
  "AuthorDisplayType": "User",
  "Status": "Draft",
  "Privacy": "Public",
  "Description": "sample string 5",
  "DatePublished": "2024-05-17T10:42:48.730029Z",
  "DateAvailable": "2024-05-17T10:42:48.730029Z",
  "DateExpires": "2024-05-17T10:42:48.730029Z",
  "TimeZone": "sample string 6",
  "CreatedByUserId": 7,
  "OrganizationId": 1,
  "NumberOfAttachments": 1,
  "OrganizationName": "sample string 8",
  "DisableComments": true,
  "CoverPhotoUrl": "https://x362.blob.core.windows.net/resources/sample string 10",
  "FileUrl": "https://x362.blob.core.windows.net/resources/sample string 11"
}