GET /asset-lineages

1 min

GET

https://api.cmp.optimizely.com/v3/asset-lineages

Experimental Get the list of asset lineage.

Query Parameters

asset_idstring
Example
1265ca474ba987cc925164aa7
Description
Unique identifier of the asset. Can be appended multiple times, such as asset_id=assetId1&asset_id=assetId2
used_instring
Example
external
Description
Indicates where an asset is being used.
Allowed
external
created_at__fromstring<date-time>
Example
2018-11-30T13:32:44Z
Description
Date and time as the lower limit to filter asset lineages by created_at, in ISO 8601 UTC format
Format
date-time
created_at__tostring<date-time>
Example
2018-11-30T13:32:44Z
Description
Date and time as the upper limit to filter asset lineages by created_at, in ISO 8601 UTC format
Format
date-time
offsetinteger
Example
5
Description
Starting index of results (zero indexed)
Default
0
Minimum
0
page_sizeinteger
Example
15
Description
Number of results to return per page
Default
10
Minimum
1
Maximum
100

Responses

200List of fetched asset lineage

object
- dataAssetLineageResponse[]required
  Description
  List of asset lineage
  - idstringrequired
    Example
    5d7f910551b00a722e0418830cee6631
    Description
    Unique identifier of the asset lineage
  - namestringrequired
    Example
    Sample Name
    Description
    Name of the source
  - asset_idstringrequired
    Example
    5d7f910551b00a722e0418830cee6632
    Description
    Unique identifier of the asset
  - version_idstringrequired
    Example
    5d7f910551b00a722e0418830cee6633
    Description
    Unique identifier of the asset version
  - used_instring<external>required
    Example
    external
    Description
    Indicates where the asset is being used
    Allowed
    external
  - uristringrequired
    Example
    https://somewebsite.com
    Description
    Unique identifier of the location where the asset is being used
  - icon_urlstringrequired
    Example
    https://somewebsite.com/abc.png
    Description
    Icon url of the asset lineage
  - rendition_idstringrequired
    Example
    1d7491a891b00a721e0419630a7f8a4b
    Description
    Unique identifier of a rendition of the asset
  - created_atstring<date-time>required
    Example
    2019-10-06T13:15:30Z
    Description
    Date and time on which the asset lineage was created, in ISO 8601 UTC format (2020-02-10T10:40
    )
    Format
    date-time
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/assets/5d7f910551bw0a722e0418830cee6632/lineages/5d7f910551bw0a722e0418830cee6631
      Description
      URL of the asset lineage
    - assetstringrequired
      Example
      https://api.cmp.optimizely.com/v3/articles/5d7f910551bw0a722e0418830cee6632
      Description
      URL of the asset
- paginationobjectrequired
  - Pagination
    - nextstringrequired
      Example
      https://api.cmp.optimizely.com/<some-path-to-next-page>?offset=10&page_size=10
      Description
      URL to the next page
    - previousstringrequired
      Description
      URL to the previous page
  - object
    - nextstring
      Example
      https://api.cmp.optimizely.com/v3/asset-lineages?offset=10&page_size=10

400Client error

Error
Example
```
{
  "message": "Unsupported arguments: a,b,c"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request GET \
     --url 'https://api.cmp.optimizely.com/v3/asset-lineages?offset=5&page_size=10' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/asset-lineages?offset=5&page_size=10", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cmp.optimizely.com/v3/asset-lineages?offset=5&page_size=10")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/asset-lineages?offset=5&page_size=10"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// List of fetched asset lineage
{
  "data": [
    {
      "id": "5d7f910551b00a722e0418830cee6631",
      "name": "Sample Name",
      "asset_id": "5d7f910551b00a722e0418830cee6632",
      "version_id": "5d7f910551b00a722e0418830cee6633",
      "used_in": "external",
      "uri": "https://somewebsite.com",
      "icon_url": "https://somewebsite.com/abc.png",
      "rendition_id": "1d7491a891b00a721e0419630a7f8a4b",
      "created_at": "2019-10-06T13:15:30Z",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/assets/5d7f910551bw0a722e0418830cee6632/lineages/5d7f910551bw0a722e0418830cee6631",
        "asset": "https://api.cmp.optimizely.com/v3/articles/5d7f910551bw0a722e0418830cee6632"
      }
    }
  ],
  "pagination": {}
}

400

// Client error
{
  "message": "Not found",
  "errors": ""
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}