Export (Retired)

List all inventory exports

Index returns a list of inventory exports to which an org has access. Retrieves file list by filter params

get/vis/v2/orgs/{orgId}/exports

Request

Base URL
https://api.flexera.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/flexera/apis/it-visibility-api/docs/vis/v2/orgs/:orgId/exports/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

orgIdinteger required

The unique identifier for the organization

Example:100

Query parameters

filterstring

Optional filter for returning requests matching specific criteria.

The following filters are supported:

Filter	Description	Allowed Operator	Behavior	Example
id	Filters on the export id	eq	Equal - The attribute and operator values must be identical for a match	id eq '12345'
name	Filters on the export name	co	Contains - The entire operator value must be a substring of the attribute value for a match.	name co 'hardware'
		eq	Equal - The attribute and operator values must be identical for a match.	name eq 'hardware_technopedia'
type	Filters on the type	eq	Equal - The attribute and operator values must be identical for a match.	type eq 'Delta'
createdAt	Filters on the createdAt	eq	Equal - The attribute and operator values must be identical for a match.	createdAt eq '2022-02-22'
size	Filters on the export Size	gt	Greater than - The attribute must be greater than than operator values for a match.	size gt '150'
		lt	Less than - The attribute must be less than than operator values for a match.	size gt '150'

All operators are case-sensitive and only lowercase is allowed.
```
  e.g: 
  	valid	: eq
  	invalid : EQ
```
Filters can be combined using the and/or logical operator. e.g: (name co 'hardware' or name eq 'software_technopedia')
When used as a query string, the filter parameter value must be URL encoded.
```
  e.g: ?filter=(name%20co%20'hardware'%20or%20name%20eq%20'software_technopedia')
```
When using cURL, the same expression can be URL encoded as follows: $ curl -s {$BASE_URL}/vis/v2/orgs/{$ORG_ID}/exports
-H "Authorization: Bearer $TOKEN"
-G --data-urlencode "filter=(name co 'hardware' or name eq 'software_technopedia')"

Example:type eq 'snapshot' and size ge 0

skipTokenstring

An opaque token to be provided when requesting a subsequent page after receiving a partial response. Partial responses will include a "nextPage" attribute in their response body, which contains the URL of the next page including the appropriate skipToken.

Example:19u2349

Response

OK response.

countinteger

The count is the number of Export data objects in the list.

nextPagestring uri

URL to the next page of data. If nextPage is not present, the returned page of data is the last.

prevPagestring uri

URL to the previous page of data. The first page of data will not return a prevPage value.

Example response

{
  "count": 20,
  "nextPage": "/vis/v2/orgs/{orgId}/exports?skipToken=19u2349",
  "prevPage": "/vis/v2/orgs/{orgId}/exports?skipToken=8b1750u",
  "values": [
    {
      "createdAt": "2018-05-16T16:31:52.1000Z",
      "id": "7d795afa-c508-4d47-92ae-248113a792d1",
      "name": "hardware_inventory",
      "size": 1080,
      "type": "snapshot"
    },
    {
      "createdAt": "2018-05-16T16:31:52.1000Z",
      "id": "7d795afa-c508-4d47-92ae-248113a792d1",
      "name": "hardware_inventory",
      "size": 1080,
      "type": "snapshot"
    },
    {
      "createdAt": "2018-05-16T16:31:52.1000Z",
      "id": "7d795afa-c508-4d47-92ae-248113a792d1",
      "name": "hardware_inventory",
      "size": 1080,
      "type": "snapshot"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.