GET /api/v2/entity-news
List entity news


GET /api/v2/entity-news/:id
Show an entity news

Params

Param name Description
id
required

Entity News ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


POST /api/v2/entity-news
Create an entity news

Params

Param name Description
data
required

Entity News information

Validations:

  • Must be a Hash

data[type]
required

Validations:

data[attributes]
required

Validations:

  • Must be a Hash

data[attributes][title]
required

Validations:

  • Must be a String

data[attributes][content]
required

Validations:

  • Must be a String

data[attributes][url]
optional , nil allowed

Validations:

  • Must be a String

data[attributes][release_time]
required

Validations:

  • Must be a DateTime

data[relationships]
required

Validations:

  • Must be a Hash

data[relationships][entity]
required

Validations:

  • Must be a Hash

data[relationships][entity][type]
required

Validations:

data[relationships][entity][id]
required

Entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/entity-news/:id
Update an entity news

Params

Param name Description
id
required

Entity News ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

Entity News information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][title]
optional

Validations:

  • Must be a String

data[attributes][content]
optional

Validations:

  • Must be a String

data[attributes][url]
optional , nil allowed

Validations:

  • Must be a String

data[attributes][release_time]
optional

Validations:

  • Must be a DateTime

data[relationships]
optional

Validations:

  • Must be a Hash

data[relationships][entity]
optional

Validations:

  • Must be a Hash

data[relationships][entity][type]
optional

Validations:

data[relationships][entity][id]
optional

Entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


DELETE /api/v2/entity-news/:id
Delete an entity news

Params

Param name Description
id
required

Entity News ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.