PUT api/FairPlayDataSets/{id}

Updates a FairPlay data set.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the data set to update.

globally unique identifier

Required

Body Parameters

The new data for the data set.

UpdatedFairPlayDataSet
NameDescriptionTypeAdditional information
Name

The name of the data set.

string

Max length: 256

Min length: 1

ApplicationSecretKey

The application secret key.

Collection of byte

Required

Max length: 16

Min length: 16

ApplicationCertificate

The X.509 application certificate in DER format.

Collection of byte

Required

PrivateKey

The 1024-bit RSA private key in the PKCS#1 PEM format, not password protected.

Collection of byte

Required

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "ApplicationSecretKey": "QEA=",
  "ApplicationCertificate": "QEA=",
  "PrivateKey": "QEA="
}

Response Information

Resource Description

FairPlayDataSet
NameDescriptionTypeAdditional information
Id

The ID of the data set.

globally unique identifier

Required

Name

The name of the data set.

string

None.

CertificateHash

The hash of the certificate.

Collection of byte

Required

Max length: 20

Min length: 20

Created

The date when the data set was created (in the ISO 8601 format).

date

Required

Updated

The date when the data set was updated last time (in the ISO 8601 format).

date

None.

Status Codes

All HTTP status codes must be expected, but the following status codes are the most probable:

  • OK (200) - The data set is successfully updated.
  • BadRequest (400) - The ID of the data set or the updated data for the data set is invalid.
  • NotFound (404) - The data set with the specified ID is not found.

Response Formats

application/json, text/json

Sample:
{
  "Id": "ccbf0504-8cc4-4072-8287-e84f228b2e47",
  "Name": "sample string 2",
  "CertificateHash": "QEA=",
  "Created": "2024-09-11T10:51:01.642701+00:00",
  "Updated": "2024-09-11T10:51:01.642701+00:00"
}