Summary 
          Get available artifacts
          Description 
          Get all available artifacts from the gitlab registry.
          Route 
          GET /admin/artifacts/available
          Roles 
          
            admin 
apiread 
          
          Parameters 
          
            Details Example Schema 
          
          
            
              
                Name 
                Type 
                Required 
                Description 
               
             
            
              
    queryOptions 
    object 
    yes 
    Options for query parameters. 
   
             
          
          
            Copied to Clipboard 
            {
  "queryOptions": {
    "page": 1,
    "order": 1,
    "iapVersion": 2020.1,
    "search": "nso"
  }
}
           
          
            Copied to Clipboard 
            {
  "type": "object",
  "properties": {
    "queryOptions": {
      "title": "queryOptions",
      "type": "object",
      "properties": {
        "page": {
          "$id": "#/properties/page",
          "type": "integer",
          "description": "The page number for the request return. Used for pagination.",
          "default": 1,
          "minimum": 1,
          "examples": [
            1,
            3,
            5
          ]
        },
        "order": {
          "type": "integer",
          "description": "The sort direction: 1 for ascending or -1 for descending.",
          "default": 1,
          "enum": [
            -1,
            1
          ]
        },
        "iapVersion": {
          "type": "number",
          "description": "The version of IAP. Can be used to overwrite the release version of artifacts in the response.",
          "examples": [
            2019.3,
            2020.1
          ]
        },
        "search": {
          "type": "string",
          "description": "Search all available artifacts to find a match related to the provided query.",
          "examples": [
            "device",
            "nso"
          ]
        }
      }
    }
  },
  "required": [
    "queryOptions"
  ],
  "additionalProperties": false
}
           
          Return 
          
            Details Example Schema 
          
          
            
              
                Name 
                Type 
                Description 
               
             
            
              
                Artifacts 
                object 
                Available artifacts from the Itential OpenSource Registry. 
               
             
          
          
            Copied to Clipboard 
            {
  "packages": [
    {
      "id": 17866482,
      "versionStatus": {
        "status": "current",
        "iapVersion": "release/2020.1"
      },
      "availableUpdate": false,
      "name": "device-connection-health-check",
      "version": "0.1.0",
      "description": "Description about the functionality of an artifact",
      "author": "Itential Artifacts",
      "published": "2020-04-09T17:44:30.215Z",
      "repository": {
        "type": "git",
        "url": "https://gitlab.com:itentialopensource/pre-built-automations/content-workflow.git"
      },
      "license": "Apache-2.0",
      "keywords": [
        "Itential",
        "Itential",
        "Itential"
      ],
      "readme": "example of readme",
      "download": {
        "metadata": {
          "name": "artifact-wizard",
          "version": "1.0.0",
          "description": "Description about the functionality of an artifact",
          "author": "Itential Artifacts",
          "license": "Apache-2.0",
          "repository": {
            "type": "git",
            "url": "https://gitlab.com:itentialopensource/pre-built-automations/content-workflow.git"
          },
          "keywords": [
            "Itential"
          ],
          "gitlabId": 17866482
        },
        "manifest": {
          "bundleName": "Content-Workflow",
          "fingerprint": "5e84f892c5eab11ec2eee16d",
          "createdEpoch": "1585772690392",
          "artifacts": [
            {
              "id": "5e5ea3bd16da51d52b4a8f9f",
              "name": "device-connection-health-check",
              "type": "forms",
              "location": "/bundles/workflows/IAP Test Artifact Workflow.json"
            },
            {
              "id": "5e5ea3bd16da51d52b4a8f9f",
              "name": "device-connection-health-check",
              "type": "workflow",
              "location": "/bundles/workflows/IAP Test Artifact Workflow.json"
            }
          ]
        },
        "bundles": [
          {
            "type": "workflow"
          },
          {
            "type": "workflow"
          }
        ],
        "readme": "example of readme"
      }
    }
  ],
  "total": 71184772,
  "page": 36143810,
  "total-pages": 24553342
}
           
          
            Copied to Clipboard 
            {
  "title": "Artifacts",
  "type": "object",
  "required": [
    "packages",
    "total"
  ],
  "properties": {
    "packages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "commonProperties#/definitions/gitlabId" 
          },
          "versionStatus": {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "examples": [
                  "current"
                ]
              },
              "iapVersion": {
                "type": "string",
                "examples": [
                  "release/2020.1"
                ]
              }
            }
          },
          "availableUpdate": {
            "type": "boolean",
            "examples": [
              true,
              false
            ]
          },
          "name": {
            "$ref": "commonProperties#/definitions/name" 
          },
          "version": {
            "$ref": "commonProperties#/definitions/version" 
          },
          "description": {
            "$ref": "commonProperties#/definitions/description" 
          },
          "author": {
            "$ref": "commonProperties#/definitions/author" 
          },
          "published": {
            "type": "string",
            "examples": [
              "2020-04-09T17:44:30.215Z"
            ],
            "format": "date-time"
          },
          "repository": {
            "$ref": "commonProperties#/definitions/repository" 
          },
          "license": {
            "$ref": "commonProperties#/definitions/license" 
          },
          "keywords": {
            "$ref": "commonProperties#/definitions/keywords" 
          },
          "IAPDependencies": {
            "$ref": "commonProperties#/definitions/IAPDependencies" 
          },
          "readme": {
            "$ref": "commonProperties#/definitions/readme" 
          },
          "download": {
            "$ref": "artifact-schema" 
          }
        }
      }
    },
    "total": {
      "$id": "#/properties/total",
      "type": "integer"
    },
    "page": {
      "$id": "#/properties/page",
      "type": "integer"
    },
    "total-pages": {
      "$id": "#/properties/total-pages",
      "type": "integer"
    }
  }
}