Differences between revisions 4 and 5

Mapping of REST Calls to DrawMGT Function Calls

Contents

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.

Linking documents to their technical and contractual Grundlagen documents
- Document-to-document link:
  - drawingId
  - drawingCode of Grundlagen document
Linking Stellungnahmen, Prüfberichte and Qualitäts-Eklärungen to revisions
- Revision-to-document link:
  - revisionId
  - serialCode, linking to test document

URLs:
- reference/add
- reference/delete
CGI Parameters
- referenceTypeId
- note
- From fields:
  - documentIdFr
  - revisionIdFr
  - documentCodeFr
  - revisionCodeFr
  - serialCodeFr
- To fields:
  - documentIdTo
  - revisionIdTo
  - documentCodeTo
  - revisionCodeTo
  - serialCodeTo

Notes:

If documentId is present it is used for the link
If revisionId is present, it is used for the link
If documentCode or serialCode is present then the code value is used to find the documentId, or if the revisionCode is present, the revisionId

To do define exactly how delete will work

To do discuss and complete this section

Use the existing REST transaction
Add the ability to deliver the information in XML format by adding the CGI variable: format=xml
To discuss: add ability to filter by link type by adding CGI variable: referenceLinkTypeIds=1,2,3

-Deletions are marked like this.
+Additions are marked like this.
 Line 2:
+<<TableOfContents>>
-Line 30:
+Line 32:
-=== Reference Add and Delete ===
+=== Interface for Reference Add and Delete ===