PUT /entity/{id}/datatype
Change the DataType of the given entity. The entity's DataType controls how the entity can be accessed. For example, an entity's DataType must be set to 'open_data' in order for anonymous to be allowed to access its contents.
An entity's data type can be checked using: GET /entity/{id}/permissions to get UserEntityPermissions.isEntityOpenData
Note: The caller must be a member of the 'Synapse Access and Compliance Team' (id=464532) in order to change an Entity's type to 'OPEN_DATA' or 'AGGREGATE_DATA'. The caller must be granted UPDATE on the Entity to change its type to any other value.
The type may be provided either as the type query parameter or
in a
ChangeDataTypeRequest body. The 'AGGREGATE_DATA' type must be set using a
request body because it requires a bound
AggregateDataConfiguration.
Resource URL
https://repo-prod.prod.sagebase.org/repo/v1/entity/{id}/datatype
Resource URL Variables
| {id} |
Parameters
| type optional |
The DataType to assign, when using the query-parameter form. |
| Resource Information | |
|---|---|
| Authentication | Required |
| Required OAuth Scopes | view , modify |
| HTTP Method | PUT |
| Request Object | ChangeDataTypeRequest (application/json) |
| Response Object | DataTypeResponse (application/json) |