TAG LINE
TAG LINE
SMALL TITLE

Report / Storage

(API Version v6)


What can you do with ReportStorage?


Properties

Property Details
identity
READ-ONLY
"identity": 8
Type: Number
This is the unique numeric identifier for the ReportStorage
ownerId
READ-ONLY
"ownerId": 1
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
identifier
"identifier": "Hello World"
Type: String
generatedResult
"generatedResult": "Hello World"
Type: String
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
createdByUserId
"createdByUserId": 5
Type: Number
Unique identifier for the associated User object.
createdByUserName
"createdByUserName": "Sample Name"
Type: String
The name of the object associated with the createdByUserId property.
reportContentTypeId
"reportContentTypeId": 7
Type: Number
Unique identifier for the associated ReportContentType object.
reportContentTypeName
"reportContentTypeName": "Sample Name"
Type: String
The name of the object associated with the reportContentTypeId property.
reportStorageTypeId
"reportStorageTypeId": 9
Type: Number
Unique identifier for the associated ReportStorageType object.
reportStorageTypeName
"reportStorageTypeName": "Sample Name"
Type: String
The name of the object associated with the reportStorageTypeId property.
generated
"generated": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
reportDefinitionId
"reportDefinitionId": 3
Type: Number
Unique identifier for the associated ReportDefinition object.
reportDefinitionName
"reportDefinitionName": "Sample Name"
Type: String
The name of the object associated with the reportDefinitionId property.
storageLocationId
"storageLocationId": 0
Type: Number
Unique identifier for the associated StorageLocation object.
storageLocationName
"storageLocationName": "Sample Name"
Type: String
The name of the object associated with the storageLocationId property.
reportStorageStatusTypeId
"reportStorageStatusTypeId": 27
Type: Number
Unique identifier for the associated ReportStorageStatusType object.
reportStorageStatusTypeName
"reportStorageStatusTypeName": "Sample Name"
Type: String
The name of the object associated with the reportStorageStatusTypeId property.
errorMessage
"errorMessage": "Hello World"
Type: String
scheduleId
"scheduleId": 4
Type: Number
Unique identifier for the associated Schedule object.
scheduleName
"scheduleName": "Sample Name"
Type: String
The name of the object associated with the scheduleId property.
updated
"updated": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.


End Points

DELETEReport/Storage/{id}
Delete an instance of the ReportStorage object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the ReportStorage object.
Delete an instance of the ReportStorage object.
DELETE Report/Storage/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "reportStorage"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETReport/Storage/
Retrieve all of the ReportStorage objects.
Retrieve all of the ReportStorage objects.
GET Report/Storage/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 26,
            "ownerName": "Sample Text Data",
            "identifier": "Sample Text Data",
            "generatedResult": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 1,
            "createdByUserName": "Sample Text Data",
            "reportContentTypeId": 15,
            "reportContentTypeName": "Sample Text Data",
            "reportStorageTypeId": 11,
            "reportStorageTypeName": "Sample Text Data",
            "generated": "2021-04-26T15:25:27.587Z",
            "reportDefinitionId": 8,
            "reportDefinitionName": "Sample Text Data",
            "storageLocationId": 0,
            "storageLocationName": "Sample Text Data",
            "reportStorageStatusTypeId": 19,
            "reportStorageStatusTypeName": "Sample Text Data",
            "errorMessage": "Sample Text Data",
            "scheduleId": 21,
            "scheduleName": "Sample Text Data",
            "updated": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETReport/Storage/Paged
Retrieve all of the ReportStorage objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the ReportStorage objects in a paged fashion.
GET Report/Storage/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 7,
                "ownerName": "Sample Text Data",
                "identifier": "Sample Text Data",
                "generatedResult": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 0,
                "createdByUserName": "Sample Text Data",
                "reportContentTypeId": 14,
                "reportContentTypeName": "Sample Text Data",
                "reportStorageTypeId": 21,
                "reportStorageTypeName": "Sample Text Data",
                "generated": "2021-04-26T15:25:27.587Z",
                "reportDefinitionId": 22,
                "reportDefinitionName": "Sample Text Data",
                "storageLocationId": 2,
                "storageLocationName": "Sample Text Data",
                "reportStorageStatusTypeId": 2,
                "reportStorageStatusTypeName": "Sample Text Data",
                "errorMessage": "Sample Text Data",
                "scheduleId": 3,
                "scheduleName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
GETReport/Storage/{id}
Retrieve an instance of the ReportStorage object by its ID.
{id}Unique identifier for the ReportStorage object.
Retrieve an instance of the ReportStorage object by its ID.
GET Report/Storage/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 25,
        "ownerName": "Sample Text Data",
        "identifier": "Sample Text Data",
        "generatedResult": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 11,
        "createdByUserName": "Sample Text Data",
        "reportContentTypeId": 27,
        "reportContentTypeName": "Sample Text Data",
        "reportStorageTypeId": 5,
        "reportStorageTypeName": "Sample Text Data",
        "generated": "2021-04-26T15:25:27.587Z",
        "reportDefinitionId": 1,
        "reportDefinitionName": "Sample Text Data",
        "storageLocationId": 10,
        "storageLocationName": "Sample Text Data",
        "reportStorageStatusTypeId": 19,
        "reportStorageStatusTypeName": "Sample Text Data",
        "errorMessage": "Sample Text Data",
        "scheduleId": 18,
        "scheduleName": "Sample Text Data",
        "updated": "2021-04-26T15:25:27.587Z"
    }
}
POSTReport/Storage/
Create a new instance of the ReportStorage object.
Create a new instance of the ReportStorage object.
POST Report/Storage/

{
    "identifier": "Sample Text Data",
    "generatedResult": "Sample Text Data",
    "createdByUserId": 16,
    "reportContentTypeId": 11,
    "reportStorageTypeId": 22,
    "generated": "2021-04-26T15:25:27.587Z",
    "reportDefinitionId": 17,
    "storageLocationId": 19,
    "reportStorageStatusTypeId": 4,
    "errorMessage": "Sample Text Data",
    "scheduleId": 10,
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 23,
                "ownerName": "Sample Text Data",
                "identifier": "Sample Text Data",
                "generatedResult": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 27,
                "createdByUserName": "Sample Text Data",
                "reportContentTypeId": 6,
                "reportContentTypeName": "Sample Text Data",
                "reportStorageTypeId": 17,
                "reportStorageTypeName": "Sample Text Data",
                "generated": "2021-04-26T15:25:27.587Z",
                "reportDefinitionId": 15,
                "reportDefinitionName": "Sample Text Data",
                "storageLocationId": 11,
                "storageLocationName": "Sample Text Data",
                "reportStorageStatusTypeId": 8,
                "reportStorageStatusTypeName": "Sample Text Data",
                "errorMessage": "Sample Text Data",
                "scheduleId": 2,
                "scheduleName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
POSTReport/Storage/identityOnly
Create a new instance of the ReportStorage object.
Create a new instance of the ReportStorage object.
POST Report/Storage/identityOnly

{
    "identifier": "Sample Text Data",
    "generatedResult": "Sample Text Data",
    "createdByUserId": 18,
    "reportContentTypeId": 23,
    "reportStorageTypeId": 22,
    "generated": "2021-04-26T15:25:27.587Z",
    "reportDefinitionId": 21,
    "storageLocationId": 22,
    "reportStorageStatusTypeId": 4,
    "errorMessage": "Sample Text Data",
    "scheduleId": 4,
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 20,
                "ownerName": "Sample Text Data",
                "identifier": "Sample Text Data",
                "generatedResult": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 6,
                "createdByUserName": "Sample Text Data",
                "reportContentTypeId": 10,
                "reportContentTypeName": "Sample Text Data",
                "reportStorageTypeId": 27,
                "reportStorageTypeName": "Sample Text Data",
                "generated": "2021-04-26T15:25:27.587Z",
                "reportDefinitionId": 8,
                "reportDefinitionName": "Sample Text Data",
                "storageLocationId": 14,
                "storageLocationName": "Sample Text Data",
                "reportStorageStatusTypeId": 26,
                "reportStorageStatusTypeName": "Sample Text Data",
                "errorMessage": "Sample Text Data",
                "scheduleId": 21,
                "scheduleName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
PUTReport/Storage/{id}
Update an existing instance of the ReportStorage object.
Update an existing instance of the ReportStorage object.
PUT Report/Storage/{id}

{
    "identity": 1,
    "identifier": "Sample Text Data",
    "generatedResult": "Sample Text Data",
    "createdByUserId": 14,
    "reportContentTypeId": 10,
    "reportStorageTypeId": 11,
    "generated": "2021-04-26T15:25:27.587Z",
    "reportDefinitionId": 21,
    "storageLocationId": 20,
    "reportStorageStatusTypeId": 1,
    "errorMessage": "Sample Text Data",
    "scheduleId": 0,
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 6,
                "ownerName": "Sample Text Data",
                "identifier": "Sample Text Data",
                "generatedResult": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 26,
                "createdByUserName": "Sample Text Data",
                "reportContentTypeId": 10,
                "reportContentTypeName": "Sample Text Data",
                "reportStorageTypeId": 2,
                "reportStorageTypeName": "Sample Text Data",
                "generated": "2021-04-26T15:25:27.587Z",
                "reportDefinitionId": 27,
                "reportDefinitionName": "Sample Text Data",
                "storageLocationId": 4,
                "storageLocationName": "Sample Text Data",
                "reportStorageStatusTypeId": 9,
                "reportStorageStatusTypeName": "Sample Text Data",
                "errorMessage": "Sample Text Data",
                "scheduleId": 27,
                "scheduleName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}