Jump to

• Request
• Response

Get all top level artifacts

get

/epm/rest/v1/artifacts

Request

Query Parameters

• fields(required): array
  A comma separated list of fields to return for each artifact. If no fields are specified, the default fields (artifactId, name, description, type) will be included.
• limit(required): integer(int64)
  The maximum number of Artifacts to return.
• offset(required): integer(int64)
  The list of Artifacts returned will start at this offset into the full list.
• orderBy(required): array
  A comma separated list of fields used to sort the list of Artifacts being returned. The value is specified by the format "field:order" where order is either "asc" for ascending or "desc" for descending.
• q(required): string
  The query used to filter the Artifacts. The expression format must adhere to the SCIM Protocol Filtering Specification RFC 7644 Section 3.4.2.2.

  Example:

  q=description co "Budget" and modifiedDate gt "2017-01-01T12:00:00Z"

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request successful

Body ()

Root Schema : ItemCollectionArtifact

Type: object

Show Source

• count: integer (int32)
  Read Only: true
• hasMore: boolean
  Read Only: true
• items: array items
  Read Only: true
• limit: integer (int32)
• links: array links
  Read Only: true
• offset: integer (int32)
  Read Only: true
• totalResults: integer (int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Artifact"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Read Only: true

Show Source

• Array of: object Artifact
  Narrative Reporting Library Artifact

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Artifact"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Artifact

Type: object

Narrative Reporting Library Artifact

Show Source

• artifactId: string
  Read Only: true
• artifactImage: string
  Read Only: true
• children: object ItemCollectionArtifact
• createdBy: string
  Read Only: true
• creationDate: string (date-time)
  Read Only: true
• description: string
• favorite: boolean
  Read Only: true
• lastAccessed: string (date-time)
  Read Only: true
• links: array links
  Read Only: true
• mimeType: string
  Read Only: true
• modifiedBy: string
  Read Only: true
• modifiedDate: string (date-time)
  Read Only: true
• name: string
• ordinal: integer (int32)
  Read Only: true

  An artifact's ordinal represents the artifact's display position to the other artifacts in the given folder (e.g. favorites). The position is set by the end user. If the ordinal is -1, there is no position set by the end user.
• pathName: string
• systemPath: string
• type: string
• typeID: string
  Read Only: true
• typeLabel: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "artifactId":{
            "type":"string",
            "readOnly":true
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "typeID":{
            "type":"string",
            "readOnly":true
        },
        "typeLabel":{
            "type":"string",
            "readOnly":true
        },
        "pathName":{
            "type":"string"
        },
        "systemPath":{
            "type":"string"
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "creationDate":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "modifiedBy":{
            "type":"string",
            "readOnly":true
        },
        "modifiedDate":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "lastAccessed":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "favorite":{
            "type":"boolean",
            "readOnly":true
        },
        "mimeType":{
            "type":"string",
            "readOnly":true
        },
        "artifactImage":{
            "type":"string",
            "readOnly":true
        },
        "ordinal":{
            "type":"integer",
            "description":"An artifact's ordinal represents the artifact's display position to the other artifacts in the given folder (e.g. favorites). The position is set by the end user. If the ordinal is -1, there is no position set by the end user.",
            "format":"int32",
            "readOnly":true
        },
        "children":{
            "$ref":"#/components/schemas/ItemCollectionArtifact"
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "description":"Narrative Reporting Library Artifact"
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• rel: string
  Allowed Values: [ "self", "next", "prev", "first", "canonical", "parent" ]

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "prev",
                "first",
                "canonical",
                "parent"
            ]
        },
        "href":{
            "type":"string"
        }
    }
}

400 Response

Invalid parameter

500 Response

Service Error

Back to Top