Build Version:

GET audits

Gets a list of audit records.

Request Information

» Expands

Name	Description	Usage
auditSourceType	This will retrieve the related audit source type.	GET audits?expand=auditsourcetype
auditStatus	This will retrieve the related audit status.	GET audits?expand=auditstatus
auditType	This will retrieve the related audit type.	GET audits?expand=audittype
catalogs	This will retrieve the related catalogs.	GET audits?expand=catalogs
categories	This will retrieve the related list of categories.	GET audits?expand=categories
portal	This will retrieve the related list of portals.	GET audits?expand=portal
product	This will retrieve the related product.	GET audits?expand=product

» Filters

Name	Description	Usage
auditTypeId	This will filter the request by audit type ID.	GET audits?filter=audittypeid~{operator}~{value}
createDate	This will filter the request by create date.	GET audits?filter=createdate~{operator}~{value}
createdBy	This will filter the request by created by.	GET audits?filter=createdby~{operator}~{value}
externalId	This will filter the request by external ID.	GET audits?filter=externalid~{operator}~{value}
processedDate	This will filter the request by processed date.	GET audits?filter=processeddate~{operator}~{value}
sourceId	This will filter the request by source ID.	GET audits?filter=sourceid~{operator}~{value}
sourceTypeId	This will filter the request by source type ID.	GET audits?filter=sourcetypeid~{operator}~{value}
statusId	This will filter the request by status ID.	GET audits?filter=statusid~{operator}~{value}

» Sorting

Name	Description	Usage
auditId	This will sort the response by audit ID.	GET audits?sort=auditid
auditTypeId	This will sort the response by audit type ID.	GET audits?sort=audittypeid
createDate	This will sort the response by create date.	GET audits?sort=createdate
externalId	This will sort the response by external ID.	GET audits?sort=externalid
processedDate	This will sort the response by processed date.	GET audits?sort=processeddate
sourceId	This will sort the response by source ID.	GET audits?sort=sourceid
sourceTypeId	This will sort the response by source type ID.	GET audits?sort=sourcetypeid

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET audits?page=index~{value}
size	The size of the page when retrieving paged results.	GET audits?page=size~{value}

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

application/json

Sample:

	{
  "Audits": [
    {
      "AuditId": 1,
      "AuditSourceType": {
        "AuditSourceTypeId": 1,
        "CreateDate": "2013-04-29T10:49:32.657",
        "CreatedBy": "Username",
        "SourceType": "Product",
        "UpdateDate": null,
        "UpdatedBy": null
      },
      "AuditSourceTypeId": 1,
      "AuditStatus": {
        "AuditStatusId": 2,
        "CreateDate": "2013-04-29T10:49:32.657",
        "CreatedBy": "Username",
        "Description": "New",
        "UpdateDate": null,
        "UpdatedBy": null
      },
      "AuditStatusId": 1,
      "AuditType": {
        "AuditTypeId": 1,
        "CreateDate": "2013-04-29T10:49:32.657",
        "CreatedBy": "Username",
        "ModificationType": "New",
        "UpdateDate": null,
        "UpdatedBy": null
      },
      "AuditTypeId": 1,
      "CreateDate": "2013-04-29T10:49:32.657",
      "CreatedBy": "Username",
      "ExternalId": null,
      "ProcessedDate": null,
      "SourceId": 1,
      "Product": null,
      "Category": null,
      "Catalog": null,
      "Portal": null
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}