Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Gets an artifact.

Package Details

Interface

IArtifactManager

Syntax

Task<T> Get<T>(int serviceRequestId, ArtifactType artifactType);

Returns

Task<T>

API Endpoint

GET /

api/v1/artifacts/{id}

Parameters:

  • id: [Integer]- An artifact id.

Expected Return:

Parameter

Description

Parameter Type

serviceRequestId

Service request id associated to the artifact.

Query string

ArtifactType

An artifact type.

  • Image = 1,

  • Pdf = 2,

  • JsonMetadata = 3,

  • JsonDocument = 4,

  • SignedJsonDocument = 5,

  • None

Query string

Returns

HTTP 200 OK if successful, 401 if unauthorized, 400 otherwise.

Example

Code Block
languagec#
public class SampleDocument
{
    public int Id  { get; set; }
    public string Name { get; set; }
    public DateTime Date { get; set; }
}
        
var doc = new SampleDocument
{
      Id = 100,
      Name = "Tom",
      Date = new DateTime(2020, 1, 1, 0, 0, 0)
};
            
var artifact = await ArtifactManager.Get<SampleDocument>(artifactInfo.Id, ArtifactType.JsonDcoument);