Skip to navigation
v2Oligos

Create an Oligo

Deprecated
Create an Oligo

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired
Name of the Oligo.
aliaseslist of stringsOptional
Aliases to add to the Oligo
authorIdslist of stringsOptional
IDs of users to set as the Oligo's authors.
basesstringOptional
Base pairs of the oligo.
customFieldsmap from strings to objectsOptional
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.
entityRegistryIdstringOptional
Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.
fieldsmap from strings to objectsOptional
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.
folderIdstringOptional
ID of the folder containing the Oligo.
namingStrategyenumOptional

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 replace name with registry ID
  • SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias
  • REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template
  • KEEP_NAMES: Keep existing entity names as registry IDs
  • REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
registryIdstringOptional

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.

schemaIdstringOptional
ID of the oligo's schema.

Response

Created

Errors

400
Bad Request Error
503
Service Unavailable Error