Skip to main content
Version: Next

GetEntityByUid

GET 
//entities/by-uid/:uid

Get a single entity by the UID.

Request​

Path Parameters

    uid stringrequired

Responses​

Ok

Schema
    relations object[]

    The relations that this entity has with other entities.

  • Array [
    • targetRefstringrequired

    The entity ref of the target of this relation.

    typestringrequired

    The type of the relation.

  • ]
    • spec object

    A type representing all allowed JSON object values.

    object
    property name*any

    A type representing all allowed JSON object values.

    metadata objectrequired

    Metadata fields common to all versions/kinds of entity.

    links object[]

    A list of external hyperlinks related to the entity.

  • Array [
    • typestring

    An optional value to categorize links into specific groups

    iconstring

    An optional semantic key that represents a visual icon.

    titlestring

    An optional descriptive title for the link.

    urlstringrequired

    The url to the external site, document, etc.

  • ]
    • tagsstring[]

    A list of single-valued strings, to for example classify catalog entities in various ways.

    annotations object

    Construct a type with a set of properties K of type T

    object
    property name*string
    labels object

    Construct a type with a set of properties K of type T

    object
    property name*string
    descriptionstring

    A short (typically relatively few words, on one line) description of the entity.

    titlestring

    A display name of the entity, to be presented in user interfaces instead of the name property above, when available. This field is sometimes useful when the name is cumbersome or ends up being perceived as overly technical. The title generally does not have as stringent format requirements on it, so it may contain special characters and be more explanatory. Do keep it very short though, and avoid situations where a title can be confused with the name of another entity, or where two entities share a title. Note that this is only for display purposes, and may be ignored by some parts of the code. Entity references still always make use of the name property, not the title.

    namespacestring

    The namespace that the entity belongs to.

    namestringrequired

    The name of the entity. Must be unique within the catalog at any given point in time, for any given namespace + kind pair. This value is part of the technical identifier of the entity, and as such it will appear in URLs, database tables, entity references, and similar. It is subject to restrictions regarding what characters are allowed. If you want to use a different, more human readable string with fewer restrictions on it in user interfaces, see the title field below.

    etagstring

    An opaque string that changes for each update operation to any part of the entity, including metadata. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations. The field can (optionally) be specified when performing update or delete operations, and the server will then reject the operation if it does not match the current stored value.

    uidstring

    A globally unique ID for the entity. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations. The field can (optionally) be specified when performing update or delete operations, but the server is free to reject requests that do so in such a way that it breaks semantics.

    property name*any

    Metadata fields common to all versions/kinds of entity.

    kindstringrequired

    The high level entity type being described.

    apiVersionstringrequired

    The version of specification format for this particular entity that this is written against.

Authorization: http

name: JWTtype: httpscheme: bearerbearerFormat: JWT
const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Authorization", "Bearer <token>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("/entities/by-uid/:uid", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));
Request Collapse all
Base URL
Auth
Parameters
— pathrequired
Feedback