mirror of
https://github.com/AnimeThemes/animethemes-api-docs.git
synced 2026-07-31 02:59:45 +02:00
67 lines
2.6 KiB
Markdown
67 lines
2.6 KiB
Markdown
---
|
|
title: Resource
|
|
---
|
|
|
|
# Resource
|
|
|
|
---
|
|
|
|
An external API resource represents a site with supplementary information for another resource such as an anime or artist.
|
|
|
|
For example, the Bakemonogatari anime has MyAnimeList, AniList and AniDB resources.
|
|
|
|
## Fields
|
|
|
|
| Name | Type | Nullable | Default | Description |
|
|
| :---------: | :-----: | :------: | :-----: | :------------------------------------------------------------------|
|
|
| id | Integer | No | Yes | The primary key of the resource |
|
|
| link | String | Yes | Yes | The URL of the external site |
|
|
| external_id | Integer | Yes | Yes | The primary key of the resource in the external site |
|
|
| site | Enum | Yes | Yes | The external site that the resource belongs to [Official Website, Twitter, AniDB, Anilist, Anime-Planet, Anime News Network, Kitsu, MyAnimeList, Wikipedia, Spotify, YouTube Music, YouTube, Apple Music, Amazon Music, Crunchyroll, HIDIVE, Netflix, Disney Plus, Hulu, Amazon Prime Video] |
|
|
| created_at | Date | No | No | The date that the resource was created |
|
|
| updated_at | Date | No | No | The date that the resource was last modified |
|
|
| deleted_at | Date | Yes | No | The date that the resource was deleted |
|
|
|
|
## Allowed Include Paths
|
|
|
|
* anime
|
|
* artists
|
|
* song
|
|
* studios
|
|
|
|
## Allowed Pivots
|
|
|
|
* animeresource
|
|
* artistresource
|
|
* songresource
|
|
* studioresource
|
|
|
|
## Endpoints
|
|
|
|
**[Resource Destroy](/content/resource/destroy/)**
|
|
|
|
The resource destroy endpoint soft deletes an external resource and returns the deleted external resource.
|
|
|
|
**[Resource Force Delete](/content/resource/forceDelete/)**
|
|
|
|
The resource force delete endpoint hard deletes an external resource and returns a confirmation message.
|
|
|
|
**[Resource Index](/content/resource/index/)**
|
|
|
|
The resource index endpoint returns a listing of external resources.
|
|
|
|
**[Resource Restore](/content/resource/restore/)**
|
|
|
|
The resource restore endpoint restores a soft deleted external resource and returns the restored external resource.
|
|
|
|
**[Resource Show](/content/resource/show/)**
|
|
|
|
The resource show endpoint returns an external resource.
|
|
|
|
**[Resource Store](/content/resource/store/)**
|
|
|
|
The resource store endpoint creates a new external resource and returns the new external resource.
|
|
|
|
**[Resource Update](/content/resource/update/)**
|
|
|
|
The resource update endpoint updates an external resource and returns the updated external resource. |