Artifact - Schema Documentation - V5.0.Revision
Documents generated: 6/7/2021

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v5/Artifact.xsd
Version 5.0.Revision
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition
  • This schema imports schema(s) from the following namespace(s):
    • http://cufxstandards.com/v5/Account.xsd (at Account.xsd)
    • http://cufxstandards.com/v5/Common.xsd (at Common.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v5/Artifact.xsd
xml http://www.w3.org/XML/1998/namespace
account http://cufxstandards.com/v5/Account.xsd
common http://cufxstandards.com/v5/Common.xsd
xs http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v5/Artifact.xsd" version="5.0.$Revision$" elementFormDefault="qualified">
<xs:import namespace="http://cufxstandards.com/v5/Account.xsd" schemaLocation="Account.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Common.xsd" schemaLocation="Common.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: artifactList

Name artifactList
Type ArtifactList
Nillable no
Abstract no
Documentation The artifacts collection/array contains all the artifacts, for instance, that the credential set is authorized to access at the Institution based on applied filters.
JSON Instance Representation
{artifactList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"artifact" : Artifact , [0..*]
artifactList}
Schema Component Representation
<xs:element name="artifactList" type="ArtifactList"/>
top

Global Definitions

Complex Type: Artifact

Name Artifact
Abstract no
Documentation An artifact is a binary representation of an image, document, etc. that needs to be stored in a back end system for later retrieval.
JSON Instance Representation
{
"artifactId" : ArtifactId , [0..1] ?
"artifactType" : xs:string , [0..1] ?
"externalId" : xs:string , [0..1] ?
"accountId" : account:AccountId , [0..1] ?
"accountType" : account:AccountType , [0..1] ?
"accountSubType" : account:AccountSubType , [0..1] ?
"partyId" : common:PartyId , [0..1] ?
"artifact" : xs:base64Binary , [1] ?
"artifactName" : xs:string , [0..1] ?
"artifactDescription" : xs:string , [0..1] ?
"artifactOwner" : xs:string , [0..1] ?
"artifactCreationDate" : xs:dateTime , [0..1] ?
"artifactModifiedDate" : xs:dateTime , [0..1] ?
"artifactArchivedDate" : xs:dateTime , [0..1] ?
"artifactDeletedDate" : xs:dateTime , [0..1] ?
"artifactCompressionType" : xs:string , [0..1] ?
"artifactUri" : ArtifactUri , [0..1] ?
"artifactArchived" : xs:boolean , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Artifact">
<xs:sequence>
<xs:element name="artifactId" type="ArtifactId" minOccurs="0" maxOccurs="1"/>
<xs:element name="artifactType" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="externalId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountId" type="account:AccountId" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountType" type="account:AccountType" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountSubType" type="account:AccountSubType" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyId" type="common:PartyId" minOccurs="0" maxOccurs="1"/>
<xs:element name="artifact" type="xs:base64Binary" minOccurs="1" maxOccurs="1"/>
<xs:element name="artifactName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="artifactDescription" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="artifactOwner" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="artifactCreationDate" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="artifactModifiedDate" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="artifactArchivedDate" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="artifactDeletedDate" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="artifactCompressionType" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="artifactUri" type="ArtifactUri" minOccurs="0" maxOccurs="1"/>
<xs:element name="artifactArchived" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ArtifactId

Name ArtifactId
Abstract no
Documentation A unique value (or values) used to identify one and only one artifact within the repository. Some artifact systems do not have a concept of a unique key but a concept of a combined key to access values in the back end system. Intended choice - Due to cross language serialization issues the choice construct has been removed. It is the responsibility of the implementer to add programmatic logic for this complex type to detect, handle and or error when population of more than one element is present.
JSON Instance Representation
{
"artifactUniqueId" : xs:string , [0..1] ?
"artifactIdKeyValueList" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="ArtifactId">
<xs:sequence>
<xs:element name="artifactUniqueId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="artifactIdKeyValueList" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ArtifactIdList

Name ArtifactIdList
Abstract no
Documentation List of artifact IDs that can be used by other objects to point to each artifact in a list.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"artifactId" : ArtifactId , [0..*]
}
Schema Component Representation
<xs:complexType name="ArtifactIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="artifactId" type="ArtifactId" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ArtifactList

Name ArtifactList
Abstract no
Documentation The artifacts collection/array contains all the artifacts, for instance, that the credential set is authorized to access at the Institution based on applied filters.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"artifact" : Artifact , [0..*]
}
Schema Component Representation
<xs:complexType name="ArtifactList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="artifact" type="Artifact" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: ArtifactUri

Name ArtifactUri
Content
  • Base XSD Type: anyURI
Schema Component Representation
<xs:simpleType name="ArtifactUri">
<xs:restriction base="xs:anyURI"/>
</xs:simpleType>
top