Schema

The schema defines all the fields that exist for a attachment object.

date
string, datetime (ISO8601)

The date the object was published, in the site's timezone.

Context: view, edit, embed

date_gmt
string, datetime (ISO8601)

The date the object was published, as GMT.

Context: view, edit

guid
object

The globally unique identifier for the object.

Read only

Context: view, edit

id
integer

Unique identifier for the object.

Read only

Context: view, edit, embed

modified
string, datetime (ISO8601)

The date the object was last modified, in the site's timezone.

Read only

Context: view, edit

modified_gmt
string, datetime (ISO8601)

The date the object was last modified, as GMT.

Read only

Context: view, edit

slug
string

An alphanumeric identifier for the object unique to its type.

Context: view, edit, embed

status
string

A named status for the object.

Context: view, edit

One of: publish, future, draft, pending, private, in-progress, failed, wc-active, wc-switched, wc-expired, wc-pending-cancel, wc-pending, wc-processing, wc-on-hold, wc-completed, wc-cancelled, wc-refunded, wc-failed, queued, processing, hold, read, unread, wcm-active, wcm-free_trial, wcm-delayed, wcm-complimentary, wcm-pending, wcm-paused, wcm-expired, wcm-cancelled

type
string

Type of Post for the object.

Read only

Context: view, edit, embed

title
object

The title for the object.

Context: view, edit, embed

author
integer

The ID for the author of the object.

Context: view, edit, embed

comment_status
string

Whether or not comments are open on the object.

Context: view, edit

One of: open, closed

ping_status
string

Whether or not the object can be pinged.

Context: view, edit

One of: open, closed

meta
object

Meta fields.

Context: view, edit

template
string

The theme file to use to display the object.

Context: view, edit

alt_text
string

Alternative text to display when attachment is not displayed.

Context: view, edit, embed

caption
object

The attachment caption.

Context: view, edit, embed

description
object

The attachment description.

Context: view, edit

media_type
string

Attachment type.

Read only

Context: view, edit, embed

One of: image, file

mime_type
string

The attachment MIME type.

Read only

Context: view, edit, embed

media_details
object

Details about the media file, specific to its type.

Read only

Context: view, edit, embed

post
integer

The ID for the associated post of the attachment.

Context: view, edit

source_url
string, uri

URL to the original attachment file.

Read only

Context: view, edit, embed

Example Request

$ curl -X OPTIONS -i http://demo.getawesomesupport.com/wp-json/wpas-api/v1/attachments

List Attachments

Arguments

context

Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

page

Current page of the collection.

Default: 1

per_page

Maximum number of items to be returned in result set.

Default: 10

search

Limit results to those matching a string.

after

Limit response to posts published after a given ISO8601 compliant date.

author

Limit result set to posts assigned to specific authors.

Default:

author_exclude

Ensure result set excludes posts assigned to specific authors.

Default:

before

Limit response to posts published before a given ISO8601 compliant date.

exclude

Ensure result set excludes specific IDs.

Default:

include

Limit result set to specific IDs.

Default:

offset

Offset the result set by a specific number of items.

order

Order sort attribute ascending or descending.

Default: desc

One of: asc, desc

orderby

Sort collection by object attribute.

Default: date

One of: author, date, id, include, modified, parent, relevance, slug, include_slugs, title

parent

Limit result set to items with particular parent IDs.

Default:

parent_exclude

Limit result set to all items except those of a particular parent ID.

Default:

slug

Limit result set to posts with one or more specific slugs.

status

Limit result set to posts assigned one or more statuses.

Default: inherit

media_type

Limit result set to attachments of a particular media type.

One of: image, video, audio, application

mime_type

Limit result set to attachments of a particular MIME type.

Definition

GET /wpas-api/v1/attachments

Example Request

$ curl http://demo.getawesomesupport.com/wp-json/wpas-api/v1/attachments

Retrieve a Attachment

Arguments

id

Unique identifier for the object.

context

Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

Definition

GET /wpas-api/v1/attachments/<id>

Example Request

$ curl http://demo.getawesomesupport.com/wp-json/wpas-api/v1/attachments/<id>

Create a Attachment

Arguments

date

The date the object was published, in the site's timezone.

date_gmt

The date the object was published, as GMT.

slug

An alphanumeric identifier for the object unique to its type.

status

A named status for the object.

One of: publish, future, draft, pending, private, in-progress, failed, wc-active, wc-switched, wc-expired, wc-pending-cancel, wc-pending, wc-processing, wc-on-hold, wc-completed, wc-cancelled, wc-refunded, wc-failed, queued, processing, hold, read, unread, wcm-active, wcm-free_trial, wcm-delayed, wcm-complimentary, wcm-pending, wcm-paused, wcm-expired, wcm-cancelled

title

The title for the object.

author

The ID for the author of the object.

comment_status

Whether or not comments are open on the object.

One of: open, closed

ping_status

Whether or not the object can be pinged.

One of: open, closed

meta

Meta fields.

template

The theme file to use to display the object.

alt_text

Alternative text to display when attachment is not displayed.

caption

The attachment caption.

description

The attachment description.

post

The ID for the associated post of the attachment.

Definition

POST /wpas-api/v1/attachments

Update a Attachment

Arguments

id

Unique identifier for the object.

date

The date the object was published, in the site's timezone.

date_gmt

The date the object was published, as GMT.

slug

An alphanumeric identifier for the object unique to its type.

status

A named status for the object.

One of: publish, future, draft, pending, private, in-progress, failed, wc-active, wc-switched, wc-expired, wc-pending-cancel, wc-pending, wc-processing, wc-on-hold, wc-completed, wc-cancelled, wc-refunded, wc-failed, queued, processing, hold, read, unread, wcm-active, wcm-free_trial, wcm-delayed, wcm-complimentary, wcm-pending, wcm-paused, wcm-expired, wcm-cancelled

title

The title for the object.

author

The ID for the author of the object.

comment_status

Whether or not comments are open on the object.

One of: open, closed

ping_status

Whether or not the object can be pinged.

One of: open, closed

meta

Meta fields.

template

The theme file to use to display the object.

alt_text

Alternative text to display when attachment is not displayed.

caption

The attachment caption.

description

The attachment description.

post

The ID for the associated post of the attachment.

Definition

POST /wpas-api/v1/attachments/<id>

Example Request

$ curl -X POST http://awesomesupport.dev/wp-json -d '{"title":"My New Title"}'

Delete a Attachment

Arguments

id

Unique identifier for the object.

force

Whether to bypass trash and force deletion.

Definition

DELETE /wpas-api/v1/attachments/<id>

Example Request

$ curl -X DELETE http://demo.getawesomesupport.com/wp-json/wpas-api/v1/attachments/<id>