Disable the Currency Rates module lifecycle.

POST

/api/workspace/admin/currency-rates/disable

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/admin/currency-rates/disable"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"Reason\": \"example\", \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/admin/currency-rates/disable';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"Reason":"example","RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/admin/currency-rates/disable \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Reason": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

WorkspaceBearer

Parameters

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Disable Currency Rates request.

object

Reason

string

nullable

RowVersion

string format: uuid

nullable

Example^generated

{
  "Reason": "example",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Disable Currency Rates request.

object

Reason

string

nullable

RowVersion

string format: uuid

nullable

Example^generated

{
  "Reason": "example",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Disable Currency Rates request.

object

Reason

string

nullable

RowVersion

string format: uuid

nullable

Example^generated

{
  "Reason": "example",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

application/json

object

Data

Currency Rates settings page detail model.

object

Summary

Currency Rates module administration summary.

object

ModuleKey

string

nullable

DisplayName

string

nullable

Description

string

nullable

IsEnabled

boolean

ConfigurationState

integer format: int32

Allowed values: 0 1 2 3 4 5

ConfigurationComplete

boolean

ConfigurationBlocked

boolean

EnabledAtUtc

string format: date-time

nullable

DisabledAtUtc

string format: date-time

nullable

DisabledReason

string

nullable

PollIntervalSeconds

integer format: int32

RevalidationWindowDays

integer format: int32

RowVersion

string format: uuid

AllowedActions

Allowed actions for the current administrator.

object

Enable

boolean

Disable

boolean

Configure

boolean

Refresh

boolean

EnabledProviderCount

integer format: int32

UsableProviderCount

integer format: int32

Providers

Array<object>

nullable

Configured provider state exposed to catalog and settings surfaces.

object

ProviderCode

string

nullable

DisplayName

string

nullable

Priority

integer format: int32

IsEnabled

boolean

CredentialsRequirement

integer format: int32

Allowed values: 0 1 2

IsCredentialReady

boolean

HealthStatus

integer format: int32

Allowed values: 0 1 2 3 4

SupportsLatest

boolean

SupportsHistorical

boolean

LastPublishedDate

string format: date

nullable

LastSuccessAtUtc

string format: date-time

nullable

LastFailureAtUtc

string format: date-time

nullable

LastCheckedAtUtc

string format: date-time

nullable

StatusMessage

string

nullable

RowVersion

string format: uuid

Credentials

Array<object>

nullable

Credential readiness for one provider.

object

ProviderCode

string

nullable

CredentialsRequirement

integer format: int32

Allowed values: 0 1 2

HasRequiredCredentials

boolean

CredentialLabel

string

nullable

UpdatedAtUtc

string format: date-time

RowVersion

string format: uuid

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Summary": {
      "ConfigurationState": 0
    },
    "Providers": [
      {
        "CredentialsRequirement": 0,
        "HealthStatus": 0
      }
    ],
    "Credentials": [
      {
        "CredentialsRequirement": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Currency Rates settings page detail model.

object

Summary

Currency Rates module administration summary.

object

ModuleKey

string

nullable

DisplayName

string

nullable

Description

string

nullable

IsEnabled

boolean

ConfigurationState

integer format: int32

Allowed values: 0 1 2 3 4 5

ConfigurationComplete

boolean

ConfigurationBlocked

boolean

EnabledAtUtc

string format: date-time

nullable

DisabledAtUtc

string format: date-time

nullable

DisabledReason

string

nullable

PollIntervalSeconds

integer format: int32

RevalidationWindowDays

integer format: int32

RowVersion

string format: uuid

AllowedActions

Allowed actions for the current administrator.

object

Enable

boolean

Disable

boolean

Configure

boolean

Refresh

boolean

EnabledProviderCount

integer format: int32

UsableProviderCount

integer format: int32

Providers

Array<object>

nullable

Configured provider state exposed to catalog and settings surfaces.

object

ProviderCode

string

nullable

DisplayName

string

nullable

Priority

integer format: int32

IsEnabled

boolean

CredentialsRequirement

integer format: int32

Allowed values: 0 1 2

IsCredentialReady

boolean

HealthStatus

integer format: int32

Allowed values: 0 1 2 3 4

SupportsLatest

boolean

SupportsHistorical

boolean

LastPublishedDate

string format: date

nullable

LastSuccessAtUtc

string format: date-time

nullable

LastFailureAtUtc

string format: date-time

nullable

LastCheckedAtUtc

string format: date-time

nullable

StatusMessage

string

nullable

RowVersion

string format: uuid

Credentials

Array<object>

nullable

Credential readiness for one provider.

object

ProviderCode

string

nullable

CredentialsRequirement

integer format: int32

Allowed values: 0 1 2

HasRequiredCredentials

boolean

CredentialLabel

string

nullable

UpdatedAtUtc

string format: date-time

RowVersion

string format: uuid

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Summary": {
      "ConfigurationState": 0
    },
    "Providers": [
      {
        "CredentialsRequirement": 0,
        "HealthStatus": 0
      }
    ],
    "Credentials": [
      {
        "CredentialsRequirement": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Conflict

application/json

object

Data

Currency Rates settings page detail model.

object

Summary

Currency Rates module administration summary.

object

ModuleKey

string

nullable

DisplayName

string

nullable

Description

string

nullable

IsEnabled

boolean

ConfigurationState

integer format: int32

Allowed values: 0 1 2 3 4 5

ConfigurationComplete

boolean

ConfigurationBlocked

boolean

EnabledAtUtc

string format: date-time

nullable

DisabledAtUtc

string format: date-time

nullable

DisabledReason

string

nullable

PollIntervalSeconds

integer format: int32

RevalidationWindowDays

integer format: int32

RowVersion

string format: uuid

AllowedActions

Allowed actions for the current administrator.

object

Enable

boolean

Disable

boolean

Configure

boolean

Refresh

boolean

EnabledProviderCount

integer format: int32

UsableProviderCount

integer format: int32

Providers

Array<object>

nullable

Configured provider state exposed to catalog and settings surfaces.

object

ProviderCode

string

nullable

DisplayName

string

nullable

Priority

integer format: int32

IsEnabled

boolean

CredentialsRequirement

integer format: int32

Allowed values: 0 1 2

IsCredentialReady

boolean

HealthStatus

integer format: int32

Allowed values: 0 1 2 3 4

SupportsLatest

boolean

SupportsHistorical

boolean

LastPublishedDate

string format: date

nullable

LastSuccessAtUtc

string format: date-time

nullable

LastFailureAtUtc

string format: date-time

nullable

LastCheckedAtUtc

string format: date-time

nullable

StatusMessage

string

nullable

RowVersion

string format: uuid

Credentials

Array<object>

nullable

Credential readiness for one provider.

object

ProviderCode

string

nullable

CredentialsRequirement

integer format: int32

Allowed values: 0 1 2

HasRequiredCredentials

boolean

CredentialLabel

string

nullable

UpdatedAtUtc

string format: date-time

RowVersion

string format: uuid

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Summary": {
      "ConfigurationState": 0
    },
    "Providers": [
      {
        "CredentialsRequirement": 0,
        "HealthStatus": 0
      }
    ],
    "Credentials": [
      {
        "CredentialsRequirement": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Disable the Currency Rates module lifecycle.

Authorizations

Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

403

Examplegenerated

409

Example

Example^generated

Example^generated

Example^generated

Example^generated