DataItems
The data item controller. Provides REST functionality for managing data items.
| API | Description |
|---|---|
| GET api/dataitems |
Retrieves the list of data items. |
| GET api/dataitems/{id} |
Retrieves a data item by id. |
| GET api/dataitems/statuslog/{id} |
Retrieves the status log entries for a data item. |
| GET api/dataitems/user/{userId} |
Retrieves a list of data items for a user. |
| POST api/dataitems/select |
Retrieves a list of data items that match the criteria. |
| POST api/dataitems/select/{pageNumber}/{pageSize} |
Retrieves a paged list of data items that match the criteria. |
| POST api/dataitems |
Creates a DataItem entity and returns the new id. |
| PUT api/dataitems/{id} |
Updates a DataItem entity. |
| PUT api/dataitems/status/{id} |
Updates the status of a DataItem. |
| DELETE api/dataitems/{id} |
Deletes a DataItem entity. |
| POST api/DataItems/ClearExpired |
Clears the expired data from the data items and sets the status. |
| POST api/DataItems/ClearCompleted |
Clears the expired data from the data items and sets the status. |
Campaigns
The schemas controller. Provides REST actions for data management campaigns.
| API | Description |
|---|---|
| GET api/campaigns/{id} |
Retrieves a campaign by its id. |
| GET api/campaigns/{id}/datafile |
Retrieves a campaign datafile by campaign id. |
| GET api/campaigns/user |
Retrieves all campaigns for the current user. |
| POST api/campaigns/select |
Retrieves a list of campaigns that match the provided criteria. |
| POST api/campaigns |
Creates a campaign entity. |
| PUT api/campaigns/{id} |
Updates a campaign entity. |
| DELETE api/campaigns/{id} |
Deletes a campaign entity. |
| POST api/campaigns/productionComplete/{id} |
Sets production to be complete on a campaign. |
| POST api/campaigns/clone |
Clones the campaign given in the . |
Reporting
The reporting controller. Provides reporting data for stats and usage.
| API | Description |
|---|---|
| POST api/reporting/dataitems |
Selects a list of data item meta data based the criteria. |
| GET api/reporting/dataitem/properties/names |
Returns the distinct recipient property names. |
| POST api/reporting/dataitems/date |
Returns the data item stats grouped by date. |
| POST api/reporting/dataitems/owner |
Returns the data item stats grouped by owner id. |
| POST api/reporting/dataitems/datalist |
Returns the data item stats grouped by data list name. |
| POST api/reporting/dataitems/bytecount |
Returns the byte count for data items that match the . |
| POST api/reporting/datafiles/bytecount |
Returns the byte count for data files that match the criteria. |
| POST api/reporting/schema/bytecount |
Returns the byte count for schema files that match the criteria. |
| POST api/reporting/dataFileUsageReport/{tenantId} |
Gets the data file usage report. |
| POST api/reporting/dataFileUploadReport/{tenantId} |
Gets the data file upload report. |
DataItemStates
The data item controller. Provides REST functionality for managing data items.
| API | Description |
|---|---|
| GET api/dataitemstates |
Retrieves the data item states. |
| GET api/dataitemstates/{id} |
Retrieves a data item state. |
| GET api/dataitemstates/datalist/{dataListId} |
Retrieves the list of data item states by data list. |
| GET api/dataitemstates/dataitem/{dataItemId} |
Retrieves the list of data item states by data item. |
| GET api/dataitemstates/name/{name} |
Retrieves the list of data item states by name. |
| POST api/dataitemstates |
Creates a DataItemState entity and returns the new id. |
| PUT api/dataitemstates/{id} |
Updates a DataItemState entity. |
| DELETE api/dataitemstates/{id} |
Deletes a DataItemState entity. |
Schemas
The schemas controller. Provides REST.
| API | Description |
|---|---|
| GET api/schemas |
Retrieves a list of schemas. |
| GET api/schemas/{id} |
Retrieves a schema by id. |
| GET api/schemas/tenant/{tenantId} |
Retrieves a list of schemas for a tenant. |
| GET api/schemas/select |
Retrieves a list of schemas that match the given . |
| GET api/schemas/samplefile/{id} |
Retrieves the sample file for a schema. |
| GET api/schemas/export/{id} |
Retrieves the export file data for a schema. |
| POST api/schemas/import |
Imports a schema using the data provided. |
| POST api/schemas |
Creates a schema entity. |
| PUT api/schemas/{id} |
Updates a schema entity. |
| DELETE api/schemas/{id} |
Deletes a schema entity. |
DataFiles
The data files controller. Provides REST functionality for managing data files.
| API | Description |
|---|---|
| GET api/datafiles/{id} |
Retrieves a data file by its id. |
| POST api/datafiles/GetDataFileDataForSuppressions/{id} |
Retrieves the file data of a data file for suppressions by its id. |
| POST api/datafiles/getfile/{id} |
Retrieves the file data of a data file by its id. |
| POST api/datafiles/getfullfile/{id} |
Retrieves the full file data of a data file by its id. |
| GET api/datafiles/user/{userId} |
Retrieves a list of data files for a given user. |
| GET api/datafiles/schema/{schemaId} |
Retrieves a list of data files for a given schema. |
| GET api/datafiles/library |
Retrieves a list of data files within the current user's library. |
| GET api/datafiles/library/{schemaId} |
Retrieves a list of data files within the current user's library restricted by schema. |
| GET api/datafiles/folder/{folderId} |
Retrieves a list of data files within a folder. |
| POST api/datafiles/select |
Retrieves a list of data files that match the provided criteria. |
| POST api/datafiles/select/{pageNumber}/{pageSize} |
Retrieves a paged list of data files that match the provided criteria. |
| POST api/datafiles |
Creates a DataFile entity and returns the new id. |
| PUT api/datafiles/{id} |
Updates a DataFile entity. |
| DELETE api/datafiles/{id} |
Deletes a DataFile entity. |
| POST api/datafiles/clearexpired |
Clears the expired data files. |
DataLists
The data list controller. Provides REST functionality for managing data lists.
| API | Description |
|---|---|
| GET api/datalists |
Retrieves a list of data lists. |
| GET api/datalists/{id} |
Retrieves a data list. |
| GET api/datalists/user/{userId} |
Retrieves a list of data lists by user. |
| GET api/datalists/folder/{folderId} |
Retrieves a list of data lists by folder. |
| POST api/datalists/select |
Retrieves a list of data lists that match the criteria. |
| POST api/datalists/getdatainformat |
Gets the data for a in the specified format. |
| POST api/datalists |
Creates a DataList entity and returns the new id. |
| PUT api/datalists/{id} |
Updates a DataList entity. |
| DELETE api/datalists/{id} |
Deletes a DataList entity. |
| POST api/datalists/flush?dataListId={dataListId} |
Flush the current data items for the data list with the given . |