Ressourcen

Bereitgestellte Ressourcen

Dieser Service stellt Daten der Typen: Tags undTagCollections bereit. Diese können per REST Schnittstelle abgefragt werden. Hierbei wird der HAL Standart eingehalten.

Ressource: Tag

Pfad: /tags/

{

  "id" : "d84056d6-c34a-47f8-a804-a7d4ed648c13",
  "tagName" : "java",

  "_links" : {
    "self" : {
      "href" : "http://api.prox.archi-lab.io/projectTags/d84056d7-c34a-47f8-a804-a7d4ed648c13"
    },
    "tag" : {
      "href" : "http://api.prox.archi-lab.io/projectTags/d84056d7-c34a-47f8-a804-a7d4ed648c13"
    }
  }
}

Beschreibung

Ein Tag ist ein Label für ein Projekt. Sie haben jeweils einen einzigartigen Namen. Einen Projekt können meherere Tags zugeordnet sein.

Feld	Type	Beschreibung	Constraints
id	UUID	Die ID des Elementes	Primary Key
tagName	Text	Der Name des Tags	max size: 40

Erklärung zu den Feldern:

Feld	Erklärung
tagName	wird immer automatisch zu Kleinbuchstaben formatiert

Links:

Links	Beschreibung
self	Self Link der Ressource
tag	Link, der auf diese Ressource zeigt

Link zu profile: "https://api.prox.archi-lab.io/profile/tags"
Link zu search: "https://api.prox.archi-lab.io/tags/search"

Search Links:

findByTagName_TagName
https://api.prox.archi-lab.io/tags/search/findByTagName_TagName{?tagName}
Es wird nach dem Tag gesucht, der den entsprechenden Namen hat.

findByTagName_TagNameContaining
https://api.prox.archi-lab.io/tags/search/findByTagName_TagNameContaining{?tagName}
Es wird nach allen Tags gesucht, die den mitgelieferten Substring im Namen haben.

tagRecommendations
https://api.prox.archi-lab.io/tags/search/tagRecommendations{?tagIds}
Es werden Tag Recommendations zurück gegeben. Dabei wird für jeden angegebenen Tag von der mitgegebenen Liste von tagIds geschaut, mit welchen anderen Tags dieser wie oft in Beziehung steht. Es werden die Tags nach Häufigkeit geordnet zurück gegeben.

Ressource: TagCollection

Pfad: /tagCollections/

{

  "referencedEntity": "4c82fcd6-f6db-417c-a1c8-08954c0f9667"

  "_links" : {
    "self" : {
      "href" : "https://api.prox.archi-lab.io/tagCollections/d84056d7-c34a-47f8-a804-a7d4ed648c13"
    },
    "tagCollection" : {
      "href" : "https://api.prox.archi-lab.io/tagCollections/d84056d7-c34a-47f8-a804-a7d4ed648c13"
    },
    "tags" : {
      "href" : "https://api.prox.archi-lab.io/tagCollections/d84056d7-c34a-47f8-a804-a7d4ed648c13/tags"
    }
  }
}

Beschreibung

Ein Tag ist ein Label für ein Projekt. Sie haben jeweils einen einzigartigen Namen. Einen Projekt können meherere Tags zugeordnet sein.

Feld	Type	Beschreibung	Constraints
referencedEntity	UUID	Die ID der Ressource, die eine Tag Collection besitzt	Primary Key

Erklärung zu den Feldern:

Feld	Erklärung
-	-

Links:

Links	Beschreibung
self	Self Link der Ressource
tagCollection	Link, der auf diese Ressource zeigt
tags	Link, der auf die Liste der Tags dieser Collection zeigt.

Mit dem Tag Link kann die Liste der Tags in der Collection aufgerufen werden.

Link zu profile: "https://api.prox.archi-lab.io/profile/tagCollections"
Link zu search: "https://api.prox.archi-lab.io/tagCollections/search"

Search Links:

-
-
-