Skip to content

Lexis Links

Operations Summary

Method Endpoint Description
GET /api/lexis-links/ List Lexis Links
GET /api/lexis-links/{uuid}/ Retrieve
POST /api/lexis-links/ Create
PUT /api/lexis-links/{uuid}/ Update
PATCH /api/lexis-links/{uuid}/ Partial Update
DELETE /api/lexis-links/{uuid}/ Delete 
1
2
3
4
http \
  GET \
  https://api.example.com/api/lexis-links/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.lexis_links import lexis_links_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = lexis_links_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: lexis_links_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { lexisLinksList } from 'waldur-js-client';

try {
  const response = await lexisLinksList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid)
query string Filter by robot account username or type
resource_uuid string (uuid)
uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
robot_account string (uri)
robot_account_username string
robot_account_type string
state string
resource_uuid string (uuid)
resource_name string
resource_type string
resource_backend_id string
resource_end_date string (date-time)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
heappe_project_id integer

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/lexis-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.lexis_links import lexis_links_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = lexis_links_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: lexis_links_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { lexisLinksRetrieve } from 'waldur-js-client';

try {
  const response = await lexisLinksRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
robot_account string (uri)
robot_account_username string
robot_account_type string
state string
resource_uuid string (uuid)
resource_name string
resource_type string
resource_backend_id string
resource_end_date string (date-time)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
heappe_project_id integer

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/lexis-links/ \
  Authorization:"Token YOUR_API_TOKEN" \
  resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.lexis_link_create_request import LexisLinkCreateRequest # (1)
from waldur_api_client.api.lexis_links import lexis_links_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = LexisLinkCreateRequest(
    resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = lexis_links_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: LexisLinkCreateRequest
  2. API Source: lexis_links_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { lexisLinksCreate } from 'waldur-js-client';

try {
  const response = await lexisLinksCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "resource": "https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
resource string (uri) ✓

201 - No response body

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/lexis-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.lexis_link_request import LexisLinkRequest # (1)
from waldur_api_client.api.lexis_links import lexis_links_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = LexisLinkRequest()
response = lexis_links_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: LexisLinkRequest
  2. API Source: lexis_links_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { lexisLinksUpdate } from 'waldur-js-client';

try {
  const response = await lexisLinksUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
heappe_project_id integer

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
robot_account string (uri)
robot_account_username string
robot_account_type string
state string
resource_uuid string (uuid)
resource_name string
resource_type string
resource_backend_id string
resource_end_date string (date-time)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
heappe_project_id integer

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/lexis-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_lexis_link_request import PatchedLexisLinkRequest # (1)
from waldur_api_client.api.lexis_links import lexis_links_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedLexisLinkRequest()
response = lexis_links_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedLexisLinkRequest
  2. API Source: lexis_links_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { lexisLinksPartialUpdate } from 'waldur-js-client';

try {
  const response = await lexisLinksPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
heappe_project_id integer

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
robot_account string (uri)
robot_account_username string
robot_account_type string
state string
resource_uuid string (uuid)
resource_name string
resource_type string
resource_backend_id string
resource_end_date string (date-time)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
heappe_project_id integer

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/lexis-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.lexis_links import lexis_links_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = lexis_links_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: lexis_links_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { lexisLinksDestroy } from 'waldur-js-client';

try {
  const response = await lexisLinksDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body