Skip to content

Science Sub Domains

Operations Summary

Method Endpoint Description
GET /api/science-sub-domains/ List Science Sub Domains
GET /api/science-sub-domains/{uuid}/ Retrieve
POST /api/science-sub-domains/ Create
PUT /api/science-sub-domains/{uuid}/ Update
PATCH /api/science-sub-domains/{uuid}/ Partial Update
DELETE /api/science-sub-domains/{uuid}/ Delete

List Science Sub Domains

1
2
3
4
http \
  GET \
  https://api.example.com/api/science-sub-domains/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.science_sub_domain_o_enum import ScienceSubDomainOEnum # (1)
from waldur_api_client.api.science_sub_domains import science_sub_domains_list # (2)

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

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

try {
  const response = await scienceSubDomainsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
domain_name string Domain name
domain_uuid string (uuid) Domain UUID
name string Name
name_exact string Name (exact)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

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

Field Type Description
uuid string (uuid)
url string (uri)
code string Sub-domain code (e.g. '1.1'). Auto-derived from domain code if left blank.
name string
domain string (uri)
domain_uuid string (uuid)
domain_name string
domain_code string Domain code (e.g. '1'). Auto-derived if left blank.
created string (date-time)
modified string (date-time)
projects_count integer Number of active projects using this sub-domain

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/science-sub-domains/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.science_sub_domains import science_sub_domains_retrieve # (1)

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

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

try {
  const response = await scienceSubDomainsRetrieve({
  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 Description
uuid string (uuid)
url string (uri)
code string Sub-domain code (e.g. '1.1'). Auto-derived from domain code if left blank.
name string
domain string (uri)
domain_uuid string (uuid)
domain_name string
domain_code string Domain code (e.g. '1'). Auto-derived if left blank.
created string (date-time)
modified string (date-time)
projects_count integer Number of active projects using this sub-domain

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/science-sub-domains/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-science-sub-domain" \
  domain="https://api.example.com/api/domain/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.science_sub_domain_request import ScienceSubDomainRequest # (1)
from waldur_api_client.api.science_sub_domains import science_sub_domains_create # (2)

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

body_data = ScienceSubDomainRequest(
    name="my-awesome-science-sub-domain",
    domain="https://api.example.com/api/domain/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = science_sub_domains_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await scienceSubDomainsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-science-sub-domain",
    "domain": "https://api.example.com/api/domain/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
code string Sub-domain code (e.g. '1.1'). Auto-derived from domain code if left blank.
name string ✓
domain string (uri) ✓

201 -

Field Type Description
uuid string (uuid)
url string (uri)
code string Sub-domain code (e.g. '1.1'). Auto-derived from domain code if left blank.
name string
domain string (uri)
domain_uuid string (uuid)
domain_name string
domain_code string Domain code (e.g. '1'). Auto-derived if left blank.
created string (date-time)
modified string (date-time)
projects_count integer Number of active projects using this sub-domain

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/science-sub-domains/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-science-sub-domain" \
  domain="https://api.example.com/api/domain/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.science_sub_domain_request import ScienceSubDomainRequest # (1)
from waldur_api_client.api.science_sub_domains import science_sub_domains_update # (2)

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

body_data = ScienceSubDomainRequest(
    name="my-awesome-science-sub-domain",
    domain="https://api.example.com/api/domain/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = science_sub_domains_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ScienceSubDomainRequest
  2. API Source: science_sub_domains_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { scienceSubDomainsUpdate } from 'waldur-js-client';

try {
  const response = await scienceSubDomainsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-science-sub-domain",
    "domain": "https://api.example.com/api/domain/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
code string Sub-domain code (e.g. '1.1'). Auto-derived from domain code if left blank.
name string ✓
domain string (uri) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
code string Sub-domain code (e.g. '1.1'). Auto-derived from domain code if left blank.
name string
domain string (uri)
domain_uuid string (uuid)
domain_name string
domain_code string Domain code (e.g. '1'). Auto-derived if left blank.
created string (date-time)
modified string (date-time)
projects_count integer Number of active projects using this sub-domain

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/science-sub-domains/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_science_sub_domain_request import PatchedScienceSubDomainRequest # (1)
from waldur_api_client.api.science_sub_domains import science_sub_domains_partial_update # (2)

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

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

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

try {
  const response = await scienceSubDomainsPartialUpdate({
  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 Description
code string Sub-domain code (e.g. '1.1'). Auto-derived from domain code if left blank.
name string
domain string (uri)

200 -

Field Type Description
uuid string (uuid)
url string (uri)
code string Sub-domain code (e.g. '1.1'). Auto-derived from domain code if left blank.
name string
domain string (uri)
domain_uuid string (uuid)
domain_name string
domain_code string Domain code (e.g. '1'). Auto-derived if left blank.
created string (date-time)
modified string (date-time)
projects_count integer Number of active projects using this sub-domain

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/science-sub-domains/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.science_sub_domains import science_sub_domains_destroy # (1)

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

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

try {
  const response = await scienceSubDomainsDestroy({
  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