CHAOS API v4

Table of contents
Index
Edit this Page

MetadataSchema

MCM module
MetadataSchema extension
MetadataSchema/Get

Gets one or all MetadataSchemas in the database.

Authentication:
  • Logged in – You need to be logged in to use this feature
  • Read permission – you will get the MetadataSchemas you have permission to read
Parameters:

metadataSchemaGUID (optional) – the GUID of the schema to get
Returns:

A list of MetadataSchemas

If no metadataSchemaGUID is given, all MetadataSchemas which the user has rights to read are returned.

<PortalResult Duration="24">
  <ModuleResults>
    <ModuleResult Fullname="MCM" Duration="0" Count="9">
      <Results>
        <Result FullName="CHAOS.MCM.Data.Dto.Standard.MetadataSchema">
          <GUID>00000000-0000-0000-0000-000063c30000</GUID>
          <Name>DKA</Name>
          <SchemaXML>
          <![CDATA[
          <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeFormDefault="unqualified" elementFormDefault="qualified"><xs:element name="DKA"><xs:complexType><xs:sequence minOccurs="0" maxOccurs="unbounded"><xs:element name="Title" type="xs:string" /><xs:element name="Abstract" type="xs:string" /><xs:element name="Description" type="xs:string" /><xs:element name="Organization" type="xs:string" /><xs:element name="Type" type="xs:string" /><xs:element name="CreatedDate" type="xs:date" minOccurs="0" maxOccurs="unbounded" /><xs:element name="FirstPublishedDate" type="xs:dateTime" /><xs:element name="Identifier" type="xs:string" /><xs:element name="Contributor"><xs:complexType><xs:sequence><xs:element name="Person" minOccurs="0" maxOccurs="unbounded"><xs:complexType><xs:attribute name="Name" type="xs:string" use="required" /><xs:attribute name="Role" type="xs:string" /></xs:complexType></xs:element></xs:sequence></xs:complexType></xs:element><xs:element name="Creator"><xs:complexType><xs:sequence><xs:element name="Person" minOccurs="0" maxOccurs="unbounded"><xs:complexType><xs:attribute name="Name" type="xs:string" use="required" /><xs:attribute name="Role" type="xs:string" /></xs:complexType></xs:element></xs:sequence></xs:complexType></xs:element><xs:element name="TechnicalComment" type="xs:string" /><xs:element name="Location" type="xs:string" /><xs:element name="RightsDescription" type="xs:string" /><xs:element name="GeoData" minOccurs="0" maxOccurs="unbounded"><xs:complexType><xs:sequence><xs:element name="Latitude" type="xs:decimal" /><xs:element name="Longitude" type="xs:decimal" /></xs:sequence></xs:complexType></xs:element><xs:element name="Categories"><xs:complexType><xs:sequence><xs:element maxOccurs="unbounded" name="Category" type="xs:string" /></xs:sequence></xs:complexType></xs:element><xs:element name="Tags"><xs:complexType><xs:sequence><xs:element maxOccurs="unbounded" name="Tag" type="xs:string" /></xs:sequence></xs:complexType></xs:element><xs:element name="Metafield" minOccurs="0" maxOccurs="unbounded"><xs:complexType><xs:sequence><xs:element name="Key" type="xs:string" /><xs:element name="Value" type="xs:string" /></xs:sequence></xs:complexType></xs:element><xs:element name="ProductionID" type="xs:string" minOccurs="0" maxOccurs="unbounded" /><xs:element name="StreamDuration" type="xs:string" minOccurs="0" maxOccurs="unbounded" /></xs:sequence></xs:complexType></xs:element></xs:schema>
          ]]>
          </SchemaXML>
          <DateCreated>09-04-2012 10:33:42</DateCreated>
        </Result>
      </Results>
    </ModuleResult>
  </ModuleResults>
</PortalResult>
MetadataSchema/Create

Adds a new MetadataSchema to the database.

You need to be logged in to use this feature and the user must have administritive rights.

Authentication:
  • Logged in – You need to be logged in to use this feature
  • Manage permission – Requires the SystemPermissons.Manage permission
Parameters:
  • name – a new name for the new schema
  • schemaXml – the XML for the new schema
  • metadataSchemaGUID (optional) – the GUID for new schema
Returns:

The GUID of the created MetadataSchema

If no metadataSchemaGUID is given, CHAOS assigns a GUID to the new schema. The new GUID is returned as a result.

MetadataSchema/Update

Updates a MetadataSchema in the database.

Authentication:
  • Logged in – You need to be logged in to use this feature
  • Write permission – you need to have write-permissions to the MetadataSchema
Parameters:
  • metadataSchemaGUID – the GUID of the schema to update
  • name – a new (or the same) name for schema
  • schemaXml – a new (or the same) XML for the schema
Returns:

The GUID of the updated MetadataSchema
MetadataSchema/Delete

Deletes a MetadataSchema in the database.

Authentication:
  • Logged in – You need to be logged in to use this feature
  • Delete permission – you need to have permissions delete the MetadataSchema (MetadataSchemaPermission.Delete)
Parameters:

guid – the GUID of the schema to delete
Returns:

The number of affected rows in the database
↑  API
Up