System Artifact Manager (REST)

The System Artifact Manager service exposes an endpoint used to retrieve the Artifact ID of a system artifact. Use this endpoint when you want to create top-level tabs or object types in a custom application. The System Artifact ID retrieved by this endpoint is passed to create requests as the parent of the new object that you want to create.

You can also use System Artifact Manager service through .NET. For more information, see System Artifact Manager (REST).

Guidelines for the System Artifact Manager service

Review the following guidelines for working with this service.

URLs

The URLs for REST endpoints contain path parameters that you need to set before making a call:

• Set the {versionNumber} placeholder to the version of the REST API that you want to use, using the format lowercase v and the version number, for example v1 or v2
• Set other path parameters in the URLs to the Artifact ID of a given entity, for example setting {workspaceID} to the Artifact ID of a workspace.

Note: To indicate the admin-level context, set the {workspaceID} path parameter to -1.

Client code sample

You can use the following .NET code as a sample client for retrieving the Artifact ID of a system artifact.

View code sample.

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
using (HttpClient client = new HttpClient())
{
    client.DefaultRequestHeaders.Add("X-CSRF-Header", "-");
    client.DefaultRequestHeaders.Add("Authorization", "Basic " + Convert.ToBase64String(Encoding.GetEncoding("ISO-8859-1").GetBytes("< user name >:< password >")));
    client.DefaultRequestHeaders.Add("X-Kepler-Version", "2.0");
    client.BaseAddress = new Uri("https://localhost/");
    int workspaceID = 1022092;
    string identifier = "System";
    int artifactID;
 
    string url = $"/Relativity.Rest/api/relativity-object-model/{versionNumber}/workspaces/{workspaceID}/system-artifacts/{identifier}/artifact-id";
    using (HttpResponseMessage response = await client.GetAsync(url))
    {
        response.EnsureSuccessStatusCode();
        artifactID = Int32.Parse(await response.Content.ReadAsStringAsync());
    }
}

Read system artifact ID

To retrieve the Artifact ID of a system artifact, send a GET request with a URL in the following format:

1
<host>/Relativity.Rest/api/relativity-object-model/{versionNumber}/workspaces/{workspaceID}/system-artifacts/{Identifier}/artifact-id

Set the path parameters as follows:

• {workspaceID} - the workspace containing the system artifact.
• {Identifier} - the string identifier for the system artifact.

Note: Use -1 to reference the admin workspace.

A successful request returns an integer value representing the artifact ID of the specified system artifact.

1
{ 1003663 }