GetJsonByServiceRequest()

Owned by Richard Potter (Unlicensed)
Last updated: Nov 17, 2020 by Leo Guo (Unlicensed)
1 min read

Description

Retrieve the content of an existing artifact of a given type using a Service Request id

Package Details

Interface

IArtifactManager

Syntax

Task<string> GetJsonByServiceRequest(int serviceRequestId, ArtifactType artifactType);

Returns

Task<string>

API Endpoint

GET /api/v1/artifacts

Parameters

Parameter

Description

Parameter Type

Parameter

Description

Parameter Type

serviceRequestId

A service request id.

Query string

artifactType

An artifact type. Possible values are:

  • Image = 1,

  • Pdf = 2,

  • JsonMetadata = 3,

  • JsonDocument = 4,

  • SignedJsonDocument = 5,

  • None

Query string

Return

Returns a list of artifacts if no artifact type is provided or a specific artifact if one is provided.

Example

const int serviceRequestId = 100; var artifact = await ArtifactManger.GetJsonByServiceRequest(int serviceRequestId, ArtifactType artifactType);