Table

cm_core_apis

Description

Core APIs

PluginCore API

Column

Format

Description

Definition

Comments

id

integer, primary key

Row identifier

autoincrement


co_idinteger, foreign keyCO IDcm_cos:id

status

varchar(2)

Status of API

  • A: Active
  • S: Suspended


api_user_idinteger, foreign keyAPI User ID with access to this APIcm_api_users:id
identifier_typevarchar(32)Identifier type used for resolving the API endpointcm_co_extended_types:name where attribute is Identifier.typeFor Identifiers attached to CO Person
index_response_typevarchar(2)How much of each record is returned in an index query
  • FL: The full record is returned
  • IL: Only the Identifier of identifier_type is returned
Added Registry v4.1.0
expunge_on_deletebooleanWhether to expunge the record on DELETE
  • true: Expunge records
  • false: Set the CoPersonRole and CoPerson status to Deleted
Added Registry v4.1.0
apivarchar(2)API to enable
  • CR: CO Person Read
  • CW: CO Person Write

  • No labels