GET api/reportserver/v1/reports/{reportId}

Returns a report by ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
reportId

Report ID.

string

Required

Body Parameters

None.

Response Information

Resource Description

ReportInfo
NameDescriptionTypeAdditional information
Id

Specifies the report identifier.

string

None.

CategoryId

Specifies the ID of the category which the report is assigned to.

string

None.

Description

Specifies the report description.

string

None.

Name

Specifies the report name.

string

None.

CreatedBy

Specifies the ID of the user who has created the report.

string

None.

LockedBy

Specifies the ID of the user who has locked the report.

string

None.

Extension

Specifies the format of the report contents (.trdx or .trdp)

string

None.

IsDraft

Specifies whether the report is a draft.

boolean

None.

IsFavorite

Specifies whether the report is favorite for the currently logged user.

boolean

None.

LastRevisionId

Specifies the ID of the last report revision.

string

None.

CreatedByName

Provides the full name of the user who has created the report.

string

None.

LockedByName

Provides the full name of the user who has locked the report.

string

None.

LastModifiedDate

Obsolete since R2 2020. Use LastModifiedDateUtc property instead. Gets the DateTime string value in the local timezone on when the report was last modified.

string

None.

LastModifiedDateUtc

Gets or sets the DateTime in UTC on when the report was last modified.

date

None.

CanEdit

Determines whether the report can be edited by the logged user.

boolean

None.

CanView

Determines whether the report can be viewed by the logged user.

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "CategoryId": "sample string 2",
  "Description": "sample string 3",
  "Name": "sample string 4",
  "CreatedBy": "sample string 5",
  "LockedBy": "sample string 6",
  "Extension": "sample string 7",
  "IsDraft": true,
  "IsFavorite": true,
  "LastRevisionId": "sample string 10",
  "CreatedByName": "sample string 11",
  "LockedByName": "sample string 12",
  "LastModifiedDate": "11/13/2024 11:07:43 AM",
  "LastModifiedDateUtc": "2024-11-13T11:07:43.5014067+00:00",
  "CanEdit": true,
  "CanView": true
}
In this article
Not finding the help you need?