Document Relationships API documentation version v1

https://{hostname}/projects/{projectId}

  • hostname: required (string)

    Aconex instance.

  • projectId: required (string)

    Identifies the project for the document relationships.

Document Relationships

API definition for Document Relationships

/documents/{documentId}/relationships/{directionId}/related-documents/{relatedDocumentId}

Relationship with direction {directionId} from document identified by {documentId} to document identified by {relatedDocumentId}.

get post delete

get

Get the relationship from source document {documentId} to {relatedDocumentId} with direction {directionId}.

post

Create the relationship from source document {documentId} to {relatedDocumentId} with direction {directionId}.

delete

Delete the relationship from source document {documentId} to {relatedDocumentId} with direction {directionId}.

Get the relationship from source document {documentId} to {relatedDocumentId} with direction {directionId}.

Secured by basic-authentication

URI Parameters

  • documentId: required (string)

    Identifies the source document for the relationship

  • directionId: required (string)

    Identifies the direction of the relationship

  • relatedDocumentId: required (string)

    Identifies the target document for the relationship

Headers

  • Accept: required (string)

    API version.

    Example:

    application/vnd.aconex.document.relationship.v1+xml

HTTP status code 200

The relationship details.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:simpleType name="DirectionId">
    <xs:restriction base="xs:string">
      <!-- Affects -->
      <xs:enumeration value="948aee85-8962-4d36-ae12-e0279fd10c99"/>
      <!-- Affected By -->
      <xs:enumeration value="0d97d641-da26-4b58-8f57-bf0115440aa2"/>
      <!-- Cancel Affect -->
      <xs:enumeration value="aa8d3bca-6317-4679-938d-a604eeb62db5"/>
      <!-- Cancel Affect By -->
      <xs:enumeration value="e7713c42-2ae6-4203-8f13-024fede0293f"/>
      <!-- Deviates From -->
      <xs:enumeration value="257bb753-f954-4d70-bc8d-f89e3760b72b"/>
      <!-- Has Deviation Of -->
      <xs:enumeration value="819cad43-0838-47f3-b4a3-e977fb1d0dfe"/>
      <!-- Implements -->
      <xs:enumeration value="2d2d8f4e-c01d-4a0a-95be-03f3af3efcb8"/>
      <!-- Implemented By -->
      <xs:enumeration value="0fae87b4-275f-4936-b439-b7c4fce858b6"/>
      <!-- Includes -->
      <xs:enumeration value="859ad735-f015-49e4-bedc-91784654d4fe"/>
      <!-- Included With -->
      <xs:enumeration value="331b8f3b-c0fc-4b30-a46c-f6b8809bb4bf"/>
      <!-- Initiates -->
      <xs:enumeration value="98deb348-629e-4586-9e67-1515ca11a674"/>
      <!-- Initiated By -->
      <xs:enumeration value="ed2c49e3-2008-4a3f-9863-556fcbd88f7e"/>
      <!-- Is Input For -->
      <xs:enumeration value="29b3317b-ece8-4199-b540-a7e3d83f5e8b"/>
      <!-- Needs Input For -->
      <xs:enumeration value="823a63c8-9b46-4cd1-a11b-cbea215ba43e"/>
      <!-- May Affect -->
      <xs:enumeration value="3b066c7f-5ab8-4475-8800-59ea76883b5f"/>
      <!-- May Be Affected -->
      <xs:enumeration value="5547ef7b-db1c-4e25-a7a5-aa2e2dda7cba"/>
      <!-- References -->
      <xs:enumeration value="5f510c61-f14c-47d8-a751-07a28ab3f344"/>
      <!-- Referenced By -->
      <xs:enumeration value="35be7473-6823-4158-87e9-f853d30e1c2c"/>
      <!-- Replaces -->
      <xs:enumeration value="ab6352ac-27d5-4c63-9bc1-26ba8958bd6d"/>
      <!-- Replaced By -->
      <xs:enumeration value="70b2a21c-145a-4834-a2b8-2c6af9bd44e2"/>
    </xs:restriction>
  </xs:simpleType>

  <xs:complexType name="Link">
    <xs:sequence>
      <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
    </xs:sequence>
    <xs:attribute name="Rel">
      <xs:simpleType>
        <xs:restriction base="xs:string"/>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="Href">
      <xs:simpleType>
        <xs:restriction base="xs:string"/>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>

  <xs:complexType name="Document">
    <xs:sequence>
      <xs:element name="Links">
        <xs:complexType>
          <xs:sequence>
            <xs:element maxOccurs="unbounded" name="Link" type="Link"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
    </xs:sequence>
    <xs:attribute name="Id">
      <xs:simpleType>
        <xs:restriction base="xs:string"/>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>

  <xs:complexType name="Relationship">
    <xs:sequence>
      <xs:element name="Document" type="Document"/>
      <xs:element name="Direction">
        <xs:complexType>
          <xs:attribute name="Id" type="DirectionId"/>
        </xs:complexType>
      </xs:element>
      <xs:element name="RelatedDocument" type="Document"/>
      <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
    </xs:sequence>
  </xs:complexType>

  <xs:element name="Relationship" type="Relationship"/>
</xs:schema>

Example:

<Relationship>
  <Document Id="{documentId}">
    <Links>
      <Link Rel="self" Href="http://{hostname}/api/projects/{projectId}/register/{documentId}/metadata"/>
    </Links>
  </Document>
  <Direction Id="5f510c61-f14c-47d8-a751-07a28ab3f344"/>
  <RelatedDocument Id="2001">
    <Links>
      <Link Rel="self" Href="http://{hostname}/api/projects/{projectId}/register/2001/metadata"/>
    </Links>
  </RelatedDocument>
</Relationship>

HTTP status code 400

Malformed request.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

HTTP status code 401

Authentication has failed or was not provided.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

HTTP status code 403

Document relationship behaviour is not enabled for the project.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

HTTP status code 404

Resource not found.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

HTTP status code 406

The Accept header is not acceptable.

HTTP status code 500

General error processing the request.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

Secured by basic-authentication

Headers

  • Authorization: required (string)

    Base64 encoded username and password.

    Example:

    Basic cG9sZWFyeTpBdXRoM250MWM=

Create the relationship from source document {documentId} to {relatedDocumentId} with direction {directionId}.

Secured by basic-authentication

URI Parameters

  • documentId: required (string)

    Identifies the source document for the relationship

  • directionId: required (string)

    Identifies the direction of the relationship

  • relatedDocumentId: required (string)

    Identifies the target document for the relationship

Headers

  • Accept: required (string)

    API version.

    Example:

    application/vnd.aconex.document.relationship.v1+xml

HTTP status code 201

The relationship has been created.

Headers

  • Location: required (string)

    Uniform Resource Identifier (URI) for the created relationship.

    Example:

    https://{hostname}/projects/{projectId}/documents/{documentId}/relationships/{directionId}/related-documents/{relatedDocumentId}

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type: object

HTTP status code 302

The relationship already exists between the documents.

Headers

  • Location: required (string)

    Uniform Resource Identifier (URI) for the relationship.

    Example:

    https://{hostname}/projects/{projectId}/documents/{documentId}/relationships/{directionId}/related-documents/{relatedDocumentId}

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

HTTP status code 400

Malformed request.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

HTTP status code 401

Authentication has failed or was not provided.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

HTTP status code 403

Document relationship behaviour is not enabled for the project.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

HTTP status code 404

Resource not found.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

HTTP status code 406

The Accept header is not acceptable.

HTTP status code 409

A conflicting relationship already exists between the documents.

Headers

  • Location: required (string)

    Uniform Resource Identifier (URI) for the existing relationship.

    Example:

    https://{hostname}/projects/{projectId}/documents/{documentId}/relationships/{directionId}/related-documents/{relatedDocumentId}

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

HTTP status code 500

General error processing the request.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

Secured by basic-authentication

Headers

  • Authorization: required (string)

    Base64 encoded username and password.

    Example:

    Basic cG9sZWFyeTpBdXRoM250MWM=

Delete the relationship from source document {documentId} to {relatedDocumentId} with direction {directionId}.

Secured by basic-authentication

URI Parameters

  • documentId: required (string)

    Identifies the source document for the relationship

  • directionId: required (string)

    Identifies the direction of the relationship

  • relatedDocumentId: required (string)

    Identifies the target document for the relationship

Headers

  • Accept: required (string)

    API version.

    Example:

    application/vnd.aconex.document.relationship.v1+xml

HTTP status code 200

The relationship has been deleted.

HTTP status code 400

Malformed request.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

HTTP status code 401

Authentication has failed or was not provided.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

HTTP status code 403

Document relationship behaviour is not enabled for the project.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

HTTP status code 404

Resource not found.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

HTTP status code 406

The Accept header is not acceptable.

HTTP status code 500

General error processing the request.

Body

Media type: application/vnd.aconex.document.relationship.v1+xml

Type:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Error" type="Error"/>
    <xs:complexType name="Error">
        <xs:sequence>
            <xs:element name="ErrorCode">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="ErrorDescription">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="RequestID">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:element name="SystemTime">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:element>
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example:

<Error>
    <ErrorCode>ERROR_CODE</ErrorCode>
    <ErrorDescription>Description for specific error</ErrorDescription>
    <RequestID>g5g8l8dk</RequestID>
    <SystemTime>2017-02-22T13:43:44.208+11:00</SystemTime>
</Error>

Secured by basic-authentication

Headers

  • Authorization: required (string)

    Base64 encoded username and password.

    Example:

    Basic cG9sZWFyeTpBdXRoM250MWM=