Sign in
Guided Redaction Management

Create a project

Creates a new manual redaction project with the specified configuration. You must specify a unique, non-empty project name.

Required Permissions

  • Global: Create Manual Redaction Project
post/api/ManualRedaction

Request body

namestring

The name of the project

fileSource'Local' | 'Sharepoint' | 'Aws' | 'Sdk' | 'Azure' | 'OneLake'

The original upload location of source files (Local, S3, Azure, SharePoint, OneLake, or SDK).

awsCredentialSource'UserProvided' | 'FromEnvironment' | 'AssumeRole'

How AWS credentials are provided: directly by the user or from the server environment.

entityOutputFormat'ReferenceCodes' | 'NoIdentifiers'
<p>Possible values:</p> <ul> <li><b>ReferenceCodes</b>: Each entity is replaced with a custom label, specified by user. When not specified, we use the entity label</li> <li><b>NoIdentifiers</b>: Each entity is fully redacted with no replacement text</li> </ul>

Response

Returns the created project

idstring
namestring
generatorSetupobject nullable
labelBlockListsobject nullable
labelAllowListsobject nullable
tagsstring[]
lastUpdatedInstant

A point in time represented as an ISO 8601 timestamp string.

createdInstant

A point in time represented as an ISO 8601 timestamp string.

fileSource'Local' | 'Sharepoint' | 'Aws' | 'Sdk' | 'Azure' | 'OneLake'

The original upload location of source files (Local, S3, Azure, SharePoint, OneLake, or SDK).

customPiiEntityIdsstring[] nullable
operationsManualRedactionProjectOperation[] nullable
awsCredentialSourcestring nullable
redactionOutputFormat'ReferenceCodes' | 'NoIdentifiers'
<p>Possible values:</p> <ul> <li><b>ReferenceCodes</b>: Each entity is replaced with a custom label, specified by user. When not specified, we use the entity label</li> <li><b>NoIdentifiers</b>: Each entity is fully redacted with no replacement text</li> </ul>
descriptionstring nullable

Changes