Create a LegalTag

Request

Create LegalTag, whose unique identifier is name. A valid LegalTag is required for data ingestion to ensure the data compliance. Allowed roles: users.datalake.editors, users.datalake.admins

Security

bearer

data-partition-idstringrequired

desired data partition id

Bodyapplication/json

namestring

The name of the LegalTag.

Example:"Some-Private-EHCData"

descriptionstring

The description of the LegalTag.

Example:"A LegalTag used for demonstration purposes."

propertiesobject(Properties)

LegalTag properties

Example:

{
  "countryOfOrigin": [
    "US"
  ],
  "contractId": "Unknown",
  "expirationDate": "2099-01-01",
  "originator": "OSDU",
  "dataType": "Public Domain Data",
  "securityClassification": "Public",
  "personalData": "No Personal Data",
  "exportClassification": "Not - Technical Data"
}

curl -i -X POST \
  https://as5.api.enterprisedata.slb.com/api/legal/v1/legaltags \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'data-partition-id: string' \
  -d '{
    "name": "slb-osdu-prod-des-prod-testing-public-usa-dataset-1",
    "description": "A LegalTag used for demonstration purposes.",
    "properties": {
      "countryOfOrigin": [
        "US"
      ],
      "contractId": "Unknown",
      "expirationDate": "2099-01-01",
      "originator": "OSDU",
      "dataType": "Public Domain Data",
      "securityClassification": "Public",
      "personalData": "No Personal Data",
      "exportClassification": "Not - Technical Data"
    }
  }'

Responses

Created LegalTag successfully.