Differences between revisions 7 and 8
Deletions are marked like this. Additions are marked like this.
Line 35: Line 35:
    * ''reference/add
    * ''reference/remove
    * ''reference/add''
    * ''reference/remove''
Line 62: Line 62:
'''''To do''''' discuss and complete this section  1. '''URLs:'''
    * ''reference/list/document/document''
    * ''reference/list/document/revision''
    * ''reference/list/document/document''
    * ''reference/list/revision/revision''
Line 64: Line 68:
 1. Use the existing REST transaction
 1. Add the ability to deliver the information in XML format by adding the CGI variable: ''format=xml''
 1. '''''To discuss:''''' add ability to filter by link type by adding CGI variable: ''referenceLinkTypeIds=1,2,3''
 1. '''CGI Parameters'''
    * ''refTypeIds'' (optional, e.g: refTypeIds='22,23,24')
    * '''From''' fields:
      * ''documentIdFr''
      * ''revisionIdFr''
      * ''documentCodeFr''
      * ''revisionCodeFr''
      * ''serialCodeFr''
    * '''To''' fields:
      * ''documentIdTo''
      * ''revisionIdTo''
      * ''documentCodeTo''
      * ''revisionCodeTo''
      * ''serialCodeTo''

 1. '''Returned XML'''

  * See the following example, assumed URL:
   * reference/list/revision/document?documentCodeFr='LA2-I-6-03-200-510-16_0001'&revisionCodeFr='v02'&refTypeIds='22,23,24'

 {{{
<?xml version='1.0' encoding='ISO8859-1'?>
<recordSet name='ObjectReferences' fromType='revision' fromId='1567' refTypeIds='22,23,24' >
  <record id='3265' type='ObjectReferences' key='objectReferenceId'>
    <drawingCode>LA2-I-6-03-200-510-16_0001 </drawingCode>
    <drawingId>6788</drawingId>
  </record>
</recordSet>
}}}

Notes:

 1. If ''documentId'' is present it is used for search links
 1. If ''revisionId'' is present, it is used for search links
 1. If ''documentCode'' or ''serialCode'' is present then the code value is used to find the ''documentId'', or if the ''revisionCode'' is present, the ''revisionId''
 1. Either '''From''' fields or '''To''' fields should be passed as '''CGI Parameters''', never both groups
 1. Format parameter is not used, always XML returned

Mapping of REST Calls to DrawMGT Function Calls

Mapping of REST calls to DrawMGT function calls is defined in app/cfg/RestMap.php.

REST Calls to Display a Revision or to Download a File

URL

Parameters

DrawMgt Function

Purpose

document/*/*/detail

drawingCode/revisionCode

DrawingsRevisionsJoinSet::restDetail

Display Document/Revision in browser

document/*/*/pub

drawingCode/revisionCode

DrawingsRevisionsJoinSet::restPublishFile

Direct download publish file through browser

document/*/*/src

drawingCode/revisionCode

DrawingsRevisionsJoinSet::restSourceFile

Direct download source file through browser

Note, that this functions are public, however they call themselves through RedirectFSM to perform user authentication if user is not logged in.

REST Calls to Manage Document/Revision Links

Requirements for Linking Documents Using the Axpo Excel Integration Spreadsheet

  1. Linking documents to their technical and contractual Grundlagen documents

    • Document-to-document link:

      • drawingId

      • drawingCode of Grundlagen document

  2. Linking Stellungnahmen, Prüfberichte and Qualitäts-Eklärungen to revisions

    • Revision-to-document link:

      • revisionId

      • serialCode, linking to test document

Suggested REST Interfaces

Interface for Reference Add and Delete

  1. URLs:

    • reference/add

    • reference/remove

  2. CGI Parameters

    • refTypeId

    • note

    • From fields:

      • documentIdFr

      • revisionIdFr

      • documentCodeFr

      • revisionCodeFr

      • serialCodeFr

    • To fields:

      • documentIdTo

      • revisionIdTo

      • documentCodeTo

      • revisionCodeTo

      • serialCodeTo

Notes:

  1. If documentId is present it is used for the link

  2. If revisionId is present, it is used for the link

  3. If documentCode or serialCode is present then the code value is used to find the documentId, or if the revisionCode is present, the revisionId

Interface for Reference List

  1. URLs:

    • reference/list/document/document

    • reference/list/document/revision

    • reference/list/document/document

    • reference/list/revision/revision

  2. CGI Parameters

    • refTypeIds (optional, e.g: refTypeIds='22,23,24')

    • From fields:

      • documentIdFr

      • revisionIdFr

      • documentCodeFr

      • revisionCodeFr

      • serialCodeFr

    • To fields:

      • documentIdTo

      • revisionIdTo

      • documentCodeTo

      • revisionCodeTo

      • serialCodeTo

  3. Returned XML

    • See the following example, assumed URL:
      • reference/list/revision/document?documentCodeFr='LA2-I-6-03-200-510-16_0001'&revisionCodeFr='v02'&refTypeIds='22,23,24'

    <?xml version='1.0' encoding='ISO8859-1'?>
    <recordSet name='ObjectReferences' fromType='revision' fromId='1567' refTypeIds='22,23,24' >
      <record id='3265' type='ObjectReferences' key='objectReferenceId'>
        <drawingCode>LA2-I-6-03-200-510-16_0001 </drawingCode>
        <drawingId>6788</drawingId>
      </record>
    </recordSet>

Notes:

  1. If documentId is present it is used for search links

  2. If revisionId is present, it is used for search links

  3. If documentCode or serialCode is present then the code value is used to find the documentId, or if the revisionCode is present, the revisionId

  4. Either From fields or To fields should be passed as CGI Parameters, never both groups

  5. Format parameter is not used, always XML returned

RestMap (last edited 2011-08-09 11:13:29 by vali)

Copyright 2008-2014, SoftXS GmbH, Switzerland