Boomi MFT - AFT Management API Reference (v1) - AdminCustomerRetentions

Toggle Pane

• AdminCustomerRetentions
  • getRetrieves customer data retention policy configuration
  • postCreates a new customer data retention policy
  • putUpdates an existing customer data retention policy
  • putSaves customer data retention policy (creates new or updates existing based on ID)

API docs by Redocly

Download OpenAPI Specification: Download

AdminCustomerRetentions

Retrieves customer data retention policy configuration

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
customerId	integer <int32>
period	integer <int32>
periodHardLimit	integer <int32>
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/AdminCustomerRetentions

https://uk.thruinc.com/api/AdminCustomerRetentions

https://eu.thruinc.com/api/AdminCustomerRetentions

https://au.thruinc.com/api/AdminCustomerRetentions

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new customer data retention policy

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Customer retention policy configuration details

id	integer <int32>
customerId	integer <int32>
period	integer <int32>
periodHardLimit	integer <int32>
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (CustomerRetentions)
recordsAffected	integer <int32>

https://us.thruinc.com/api/AdminCustomerRetentions

https://uk.thruinc.com/api/AdminCustomerRetentions

https://eu.thruinc.com/api/AdminCustomerRetentions

https://au.thruinc.com/api/AdminCustomerRetentions

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "customerId": 0,
• "period": 0,
• "periodHardLimit": 0,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing customer data retention policy

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated customer retention policy configuration

id	integer <int32>
customerId	integer <int32>
period	integer <int32>
periodHardLimit	integer <int32>
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (CustomerRetentions)
recordsAffected	integer <int32>

https://us.thruinc.com/api/AdminCustomerRetentions

https://uk.thruinc.com/api/AdminCustomerRetentions

https://eu.thruinc.com/api/AdminCustomerRetentions

https://au.thruinc.com/api/AdminCustomerRetentions

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "customerId": 0,
• "period": 0,
• "periodHardLimit": 0,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Saves customer data retention policy (creates new or updates existing based on ID)

Performs upsert operation: creates new policy if ID is 0, otherwise updates existing policy

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Customer retention policy configuration to save

id	integer <int32>
customerId	integer <int32>
period	integer <int32>
periodHardLimit	integer <int32>
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (CustomerRetentions)
recordsAffected	integer <int32>

https://us.thruinc.com/api/AdminCustomerRetentions/save

https://uk.thruinc.com/api/AdminCustomerRetentions/save

https://eu.thruinc.com/api/AdminCustomerRetentions/save

https://au.thruinc.com/api/AdminCustomerRetentions/save

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "customerId": 0,
• "period": 0,
• "periodHardLimit": 0,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample