Skip to content

Marketplace Remote Synchronisations

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-remote-synchronisations/ List Marketplace Remote Synchronisations
GET /api/marketplace-remote-synchronisations/{uuid}/ Retrieve
POST /api/marketplace-remote-synchronisations/ Create
PUT /api/marketplace-remote-synchronisations/{uuid}/ Update
PATCH /api/marketplace-remote-synchronisations/{uuid}/ Partial Update
DELETE /api/marketplace-remote-synchronisations/{uuid}/ Delete
Other Actions
POST /api/marketplace-remote-synchronisations/{uuid}/run_synchronisation/ Run synchronisation

Core CRUD

List Marketplace Remote Synchronisations

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-remote-synchronisations/ \
  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.marketplace_remote_synchronisations import marketplace_remote_synchronisations_list # (1)

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

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

try {
  const response = await marketplaceRemoteSynchronisationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
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
uuid string (uuid)
url string (uri)
api_url string (uri)
token string
remote_organization_uuid string (uuid)
remote_organization_name string
local_service_provider string (uri)
local_service_provider_name string
is_active boolean
last_execution string (date-time)
last_output string
get_state_display string
error_message string
created string (date-time)
modified string (date-time)
remotelocalcategory_set array of objects
remotelocalcategory_set.local_category string (uri)
remotelocalcategory_set.remote_category string (uuid)
remotelocalcategory_set.local_category_name string
remotelocalcategory_set.local_category_uuid string (uuid)
remotelocalcategory_set.remote_category_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-remote-synchronisations/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.marketplace_remote_synchronisations import marketplace_remote_synchronisations_retrieve # (1)

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

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

try {
  const response = await marketplaceRemoteSynchronisationsRetrieve({
  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
uuid string (uuid)
url string (uri)
api_url string (uri)
token string
remote_organization_uuid string (uuid)
remote_organization_name string
local_service_provider string (uri)
local_service_provider_name string
is_active boolean
last_execution string (date-time)
last_output string
get_state_display string
error_message string
created string (date-time)
modified string (date-time)
remotelocalcategory_set array of objects
remotelocalcategory_set.local_category string (uri)
remotelocalcategory_set.remote_category string (uuid)
remotelocalcategory_set.local_category_name string
remotelocalcategory_set.local_category_uuid string (uuid)
remotelocalcategory_set.remote_category_name string

Create

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  POST \
  https://api.example.com/api/marketplace-remote-synchronisations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  token="********" \
  remote_organization_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  remote_organization_name="string-value" \
  local_service_provider="https://api.example.com/api/local-service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  remotelocalcategory_set:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_synchronisation_request import RemoteSynchronisationRequest # (1)
from waldur_api_client.api.marketplace_remote_synchronisations import marketplace_remote_synchronisations_create # (2)

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

body_data = RemoteSynchronisationRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    token="********",
    remote_organization_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    remote_organization_name="string-value",
    local_service_provider="https://api.example.com/api/local-service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    remotelocalcategory_set=[]
)
response = marketplace_remote_synchronisations_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceRemoteSynchronisationsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "token": "********",
    "remote_organization_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "remote_organization_name": "string-value",
    "local_service_provider": "https://api.example.com/api/local-service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "remotelocalcategory_set": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
api_url string (uri) ✓
token string ✓
remote_organization_uuid string (uuid) ✓
remote_organization_name string ✓
local_service_provider string (uri) ✓
is_active boolean
remotelocalcategory_set array of objects ✓
remotelocalcategory_set.local_category string (uri) ✓
remotelocalcategory_set.remote_category string (uuid) ✓
remotelocalcategory_set.remote_category_name string

201 -

Field Type
uuid string (uuid)
url string (uri)
api_url string (uri)
token string
remote_organization_uuid string (uuid)
remote_organization_name string
local_service_provider string (uri)
local_service_provider_name string
is_active boolean
last_execution string (date-time)
last_output string
get_state_display string
error_message string
created string (date-time)
modified string (date-time)
remotelocalcategory_set array of objects
remotelocalcategory_set.local_category string (uri)
remotelocalcategory_set.remote_category string (uuid)
remotelocalcategory_set.local_category_name string
remotelocalcategory_set.local_category_uuid string (uuid)
remotelocalcategory_set.remote_category_name string

Update

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  PUT \
  https://api.example.com/api/marketplace-remote-synchronisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  token="********" \
  remote_organization_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  remote_organization_name="string-value" \
  local_service_provider="https://api.example.com/api/local-service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  remotelocalcategory_set:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_synchronisation_request import RemoteSynchronisationRequest # (1)
from waldur_api_client.api.marketplace_remote_synchronisations import marketplace_remote_synchronisations_update # (2)

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

body_data = RemoteSynchronisationRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    token="********",
    remote_organization_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    remote_organization_name="string-value",
    local_service_provider="https://api.example.com/api/local-service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    remotelocalcategory_set=[]
)
response = marketplace_remote_synchronisations_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RemoteSynchronisationRequest
  2. API Source: marketplace_remote_synchronisations_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
import { marketplaceRemoteSynchronisationsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceRemoteSynchronisationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "token": "********",
    "remote_organization_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "remote_organization_name": "string-value",
    "local_service_provider": "https://api.example.com/api/local-service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "remotelocalcategory_set": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
api_url string (uri) ✓
token string ✓
remote_organization_uuid string (uuid) ✓
remote_organization_name string ✓
local_service_provider string (uri) ✓
is_active boolean
remotelocalcategory_set array of objects ✓
remotelocalcategory_set.local_category string (uri) ✓
remotelocalcategory_set.remote_category string (uuid) ✓
remotelocalcategory_set.remote_category_name string

200 -

Field Type
uuid string (uuid)
url string (uri)
api_url string (uri)
token string
remote_organization_uuid string (uuid)
remote_organization_name string
local_service_provider string (uri)
local_service_provider_name string
is_active boolean
last_execution string (date-time)
last_output string
get_state_display string
error_message string
created string (date-time)
modified string (date-time)
remotelocalcategory_set array of objects
remotelocalcategory_set.local_category string (uri)
remotelocalcategory_set.remote_category string (uuid)
remotelocalcategory_set.local_category_name string
remotelocalcategory_set.local_category_uuid string (uuid)
remotelocalcategory_set.remote_category_name string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-remote-synchronisations/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_remote_synchronisation_request import PatchedRemoteSynchronisationRequest # (1)
from waldur_api_client.api.marketplace_remote_synchronisations import marketplace_remote_synchronisations_partial_update # (2)

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

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

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

try {
  const response = await marketplaceRemoteSynchronisationsPartialUpdate({
  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
api_url string (uri)
token string
remote_organization_name string
local_service_provider string (uri)
is_active boolean
remotelocalcategory_set array of objects
remotelocalcategory_set.local_category string (uri) ✓
remotelocalcategory_set.remote_category string (uuid) ✓
remotelocalcategory_set.remote_category_name string

200 -

Field Type
uuid string (uuid)
url string (uri)
api_url string (uri)
token string
remote_organization_uuid string (uuid)
remote_organization_name string
local_service_provider string (uri)
local_service_provider_name string
is_active boolean
last_execution string (date-time)
last_output string
get_state_display string
error_message string
created string (date-time)
modified string (date-time)
remotelocalcategory_set array of objects
remotelocalcategory_set.local_category string (uri)
remotelocalcategory_set.remote_category string (uuid)
remotelocalcategory_set.local_category_name string
remotelocalcategory_set.local_category_uuid string (uuid)
remotelocalcategory_set.remote_category_name string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-remote-synchronisations/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.marketplace_remote_synchronisations import marketplace_remote_synchronisations_destroy # (1)

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

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

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

Other Actions

Run synchronisation

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-remote-synchronisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/run_synchronisation/ \
  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.marketplace_remote_synchronisations import marketplace_remote_synchronisations_run_synchronisation # (1)

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

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

try {
  const response = await marketplaceRemoteSynchronisationsRunSynchronisation({
  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
uuid string (uuid)
url string (uri)
api_url string (uri)
token string
remote_organization_uuid string (uuid)
remote_organization_name string
local_service_provider string (uri)
local_service_provider_name string
is_active boolean
last_execution string (date-time)
last_output string
get_state_display string
error_message string
created string (date-time)
modified string (date-time)
remotelocalcategory_set array of objects
remotelocalcategory_set.local_category string (uri)
remotelocalcategory_set.remote_category string (uuid)
remotelocalcategory_set.local_category_name string
remotelocalcategory_set.local_category_uuid string (uuid)
remotelocalcategory_set.remote_category_name string