GetContentAssetList

Description

Returns array of ContentAsset Item filtered by input parameters. When any parameters are missed, the default value is used.

Input Parameters

Parameter	Description
`apiKey` (string)	To use the Q4 API, you need to have an application key. We use this to track API usage. Currently, the use of the API is allowed only with prior permission. Requests for API keys are reviewed by staff. Please get in touch with support to get the API Key.
`languageId` (int)	Specifies the language for which financial reports should be returned. The default value is 1 (English).
`tagList` (string)	If specified, the result will be filtered by tags. Tags are pipe-delimited - 'tag1\|tag2'. The default is an empty string.
`pageNumber` (int)	When paging is used, this specifies the page number to return. It is 0-based.
`pageSize` (int)	When `pageSize` is greater the 0, the paging is enabled. The default is 0 (paging disabled).
`includeTags` (bool)	Specifies that returned data records have to include associated tags. The default is false.
`year` (int)	Specifies the year for which financial reports should be returned. The result will not be filtered by year when it is not provided.
`assetType` (string)	If specified, the result will be filtered by the report type. The default is an empty string.
`sortByTitle` (bool)	Specifies that returned data records should be sorted by title. The default is false.

Sample URL

https://www.domain.com/feed/ContentAsset.svc/GetContentAssetList
apiKey=c34993dcba1942418d97656f3ed00979&languageId=1&pageNumber=0&pageSize=20&includeTags=true&year=2011

Sample Request

JSON

var data = {
    apiKey: apiKey,
    languageId: 1,
    tagList: 'Q1|Q2',
    pageNumber: 0,
    pageSize: 20,
    includeTags: true,
    year: 2011
};

$.ajax({
    type: "GET",
    url: "http://www.domain.com/feed/ContentAsset.svc/GetContentAssetList",
    data: data,
    dataType: "json",
    success: OnLoadContentAssetListSuccess,
    error: OnLoadError
});

Sample Response

JSON

{
    "GetContentAssetListResult": [{
            "ContentAssetDate": "/Date(1320123600000-0500)/",
            "ContentAssetId": 2755,
            "Description": "",
            "FileType": "pdf",
            "FileSize": 1285,
            "FilePath": "http://www.domain.com/Theme/Agnico2/files/AEM-Transcript-2010-10-28T15_00_1_.pdf",
            "IconPath": "Theme/Agnico2/files/pdficon.gif",
            "LanguageId": 1,
            "LookupWorkflowId": "05f6ff52-ad5a-4173-9feb-bb6b58d5a86c",
            "RevisionNumber": 55033,
            "TagsList": ["Q32010"],
            "ThumbnailPath": "",
            "Title": "Q3 Conference Call Transcript",
            "Type": "Default",
            "WorkflowId": "326002a5-3291-4b92-a4d5-2c5ad5e5cea2"
        },
        {
            "ContentAssetDate": "/Date(1304398800000-0500)/",
            "ContentAssetId": 2948,
            "Description": "",
            "FileType": "pdf",
            "FileSize": 1145,
            "FilePath": "http://www.domain.com/Theme/Agnico2/files/AEM_Transcript_Q1_2011_April2011.pdf",
            "IconPath": "Theme/Agnico2/files/pdficon.gif",
            "LanguageId": 1,
            "LookupWorkflowId": "05f6ff52-ad5a-4173-9feb-bb6b58d5a86c",
            "RevisionNumber": 58884,
            "TagsList": ["q12011"],
            "ThumbnailPath": "",
            "Title": "Conference Call Transcript",
            "Type": "Default",
            "WorkflowId": "11083398-47bc-4ee1-b8d1-4d0e4ea83541"
        }
    ]
}