{ "opencollection": "1.0.0", "info": { "name": "OpenTextâ„¢ Core Application Security Web API Explorer ApiKeyManagement Reports API", "version": "v3" }, "items": [ { "info": { "name": "Reports", "type": "folder" }, "items": [ { "info": { "name": "Get report summary data for the given report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v3/reports/:reportId", "params": [ { "name": "reportId", "value": "", "type": "path", "description": "The report id" } ] }, "docs": "Allowed Scopes: api-tenant, view-reports" }, { "info": { "name": "Delete a report", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v3/reports/:reportId", "params": [ { "name": "reportId", "value": "", "type": "path", "description": "The report id" } ] }, "docs": "Allowed Scopes: api-tenant, manage-reports" }, { "info": { "name": "Get a list of report summary data", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v3/reports", "params": [ { "name": "filters", "value": "", "type": "query", "description": "A delimited list of field filters.\r\n

Field name and value should be separated by a colon (:).\r\n

Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n

Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2" }, { "name": "orderBy", "value": "", "type": "query", "description": "The field name to order the results by." }, { "name": "orderByDirection", "value": "", "type": "query", "description": "The direction to order the results by. ASC and DESC are valid values." }, { "name": "fields", "value": "", "type": "query", "description": "Comma separated list of fields to return." }, { "name": "offset", "value": "", "type": "query", "description": "Offset of the starting record. 0 indicates the first record." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum records to return. The maximum value allowed is 50." } ] }, "docs": "Allowed Scopes: api-tenant, view-reports" }, { "info": { "name": "Create a new report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v3/reports" }, "docs": "Allowed Scopes: api-tenant, manage-reports" }, { "info": { "name": "Download the report in binary format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v3/reports/:reportId/download", "params": [ { "name": "reportId", "value": "", "type": "path", "description": "The report id" } ] }, "docs": "Allowed Scopes: api-tenant, view-reports" }, { "info": { "name": "Get a list of export report summary data", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v3/reports/dataexports", "params": [ { "name": "filters", "value": "", "type": "query", "description": "A delimited list of field filters.\r\n

Field name and value should be separated by a colon (:).\r\n

Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n

Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2" }, { "name": "orderBy", "value": "", "type": "query", "description": "The field name to order the results by." }, { "name": "orderByDirection", "value": "", "type": "query", "description": "The direction to order the results by. ASC and DESC are valid values." }, { "name": "fields", "value": "", "type": "query", "description": "Comma separated list of fields to return." }, { "name": "offset", "value": "", "type": "query", "description": "Offset of the starting record. 0 indicates the first record." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum records to return. The maximum value allowed is 50." } ] }, "docs": "Allowed Scopes: api-tenant, view-reports" }, { "info": { "name": "Create a new data export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v3/reports/dataexports" }, "docs": "Allowed Scopes: api-tenant, manage-reports" }, { "info": { "name": "Download the export report in binary format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v3/reports/dataexports/:dataExportId/download", "params": [ { "name": "dataExportId", "value": "", "type": "path", "description": "The data export id" } ] }, "docs": "Allowed Scopes: api-tenant, view-reports" }, { "info": { "name": "Get a list of data export templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v3/reports/dataexports/templates", "params": [ { "name": "filters", "value": "", "type": "query", "description": "A delimited list of field filters.\r\n

Field name and value should be separated by a colon (:).\r\n

Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n

Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2" }, { "name": "orderBy", "value": "", "type": "query", "description": "The field name to order the results by." }, { "name": "orderByDirection", "value": "", "type": "query", "description": "The direction to order the results by. ASC and DESC are valid values." }, { "name": "fields", "value": "", "type": "query", "description": "Comma separated list of fields to return." }, { "name": "offset", "value": "", "type": "query", "description": "Offset of the starting record. 0 indicates the first record." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum records to return. The maximum value allowed is 50." } ] }, "docs": "Allowed Scopes: api-tenant, view-reports" }, { "info": { "name": "Get data export details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v3/reports/dataexports/:dataExportId", "params": [ { "name": "dataExportId", "value": "", "type": "path", "description": "The data export id" } ] }, "docs": "Allowed Scopes: api-tenant, view-reports" } ] } ], "bundled": true }