Platform: Partitions

get

Authorizations

BearerCookie

Path parameters

settingstring · uuidRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/platform/partitions-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SettingName": "text",
  "SettingValue": "text"
}

put

Authorizations

BearerCookie

Path parameters

settingstringRequired

Body

application/jsontext/jsonapplication/*+json

SettingIdentifierstring · uuidOptional

SettingNamestring | nullableOptional

SettingValuestring | nullableOptional

Responses

200

OK

400

Bad Request

application/json

404

Not Found

put

HTTPcURLJavaScriptPython

PUT /v2/E01/platform/partitions-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SettingName": "text",
  "SettingValue": "text"
}

application/jsontext/jsonapplication/*+json

No content

delete

Authorizations

BearerCookie

Path parameters

settingstring · uuidRequired

Responses

200

OK

404

Not Found

delete

HTTPcURLJavaScriptPython

DELETE /v2/E01/platform/partitions-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

No content

head

Authorizations

BearerCookie

Path parameters

settingstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

HTTPcURLJavaScriptPython

HEAD /v2/E01/platform/partitions-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

Query parameters

SettingNamestringOptional

SettingValuestringOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

HTTPcURLJavaScriptPython

GET /v2/E01/platform/partitions-fields/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

Query parameters

SettingNamestringOptional

SettingValuestringOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/platform/partitions-fields HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "SettingName": "text",
    "SettingValue": "text"
  }
]

post

Authorizations

BearerCookie

Body

application/jsontext/jsonapplication/*+json

SettingIdentifierstring · uuidOptional

SettingNamestring | nullableOptional

SettingValuestring | nullableOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

HTTPcURLJavaScriptPython

POST /v2/E01/platform/partitions-fields HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SettingName": "text",
  "SettingValue": "text"
}

application/jsontext/jsonapplication/*+json

{
  "SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SettingName": "text",
  "SettingValue": "text"
}

get

Authorizations

BearerCookie

Query parameters

SettingNamestringOptional

SettingValuestringOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/platform/partitions-fields/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]