Platform: Partitions

get
Authorizations
Path parameters
settingstring · uuidRequired
Responses
200

OK

application/json
get
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
Path parameters
settingstringRequired
Body
SettingIdentifierstring · uuidOptional
SettingNamestring | nullableOptional
SettingValuestring | nullableOptional
Responses
200

OK

No content

put
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"
}

No content

delete
Authorizations
Path parameters
settingstring · uuidRequired
Responses
200

OK

No content

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

No content

head
Authorizations
Path parameters
settingstring · uuidRequired
Responses
200

OK

application/json
Responseboolean
head
HEAD /v2/E01/platform/partitions-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*
200

OK

true
get
Authorizations
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
GET /v2/E01/platform/partitions-fields/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*
200

OK

1
get
Authorizations
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
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
Body
SettingIdentifierstring · uuidOptional
SettingNamestring | nullableOptional
SettingValuestring | nullableOptional
Responses
201

Created

application/json
post
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"
}
{
  "SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SettingName": "text",
  "SettingValue": "text"
}
Authorizations
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
GET /v2/E01/platform/partitions-fields/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*
200

OK

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

Was this helpful?