Create an Oligo
Create an Oligo
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
name
Name of the Oligo.
aliases
Aliases to add to the Oligo
bases
Base pairs of the oligo.
customFields
Custom fields to add to the Oligo. Every field should have its name as a key, mapping to an object with information about the value of the field.
entityRegistryId
Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.
fields
Fields to set on the Oligo. Must correspond with the schema's field definitions. Every field should have its name as a key, mapping to an object with information about the value of the field.
folderId
ID of the folder containing the Oligo.
namingStrategy
Specifies the behavior for automatically generated names when registering an entity.
- NEW_IDS: Generate new registry IDs
- IDS_FROM_NAMES: Generate registry IDs based on entity names
- DELETE_NAMES: Generate new registry IDs and use them as names
- SET_FROM_NAME_PARTS: Generate new registry IDs, set names from name template, keep original as alias
- REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, set names from name template
- KEEP_NAMES: Use entity names as registry IDs
- REPLACE_ID_AND_NAME_FROM_PARTS: Set registry IDs and names from name template
registryId
Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the /registries endpoint
Required in order for entities to be created directly in the registry.
schemaId
ID of the oligo's schema.
Response
Created
Errors
400
Bad Request Error
503
Service Unavailable Error