cm4all-wp-impex REST API

Version v1

Path Table

Reference Table

Path Details


[GET]/cm4all-wp-impex/v1/export/profile/schema

  • Security
    basic

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[GET]/cm4all-wp-impex/v1/export/profile

  • Security
    basic

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[GET]/cm4all-wp-impex/v1/export/profile/{name}

  • Security
    basic

Parameters(Query)

context?: string

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[GET]/cm4all-wp-impex/v1/import/profile/schema

  • Security
    basic

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[GET]/cm4all-wp-impex/v1/import/profile

  • Security
    basic

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[GET]/cm4all-wp-impex/v1/import/profile/{name}

  • Security
    basic

Parameters(Query)

context?: string

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[GET]/cm4all-wp-impex/v1/export/schema

  • Security
    basic

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[GET]/cm4all-wp-impex/v1/export

  • Security
    basic

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[POST]/cm4all-wp-impex/v1/export

  • Security
    basic

RequestBody

  • multipart/form-data
{
  // The options used to create the export.
  options?: string
  // The name of the export profile to use.
  profile?: string
  // The human readable name of the export
  name?: string
  // The human readable description of the export
  description?: string
}

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[GET]/cm4all-wp-impex/v1/export/{id}

  • Security
    basic

Parameters(Query)

context?: string

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[POST]/cm4all-wp-impex/v1/export/{id}

  • Security
    basic

RequestBody

  • multipart/form-data
{
  // The options used to create the export.
  options?: string
  // The name of the export profile to use.
  profile?: string
  // The human readable name of the export
  name?: string
  // The human readable description of the export
  description?: string
}

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[PUT]/cm4all-wp-impex/v1/export/{id}

  • Security
    basic

Parameters(Query)

options?: string
profile?: string
name?: string
description?: string

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[PATCH]/cm4all-wp-impex/v1/export/{id}

  • Security
    basic

Parameters(Query)

options?: string
profile?: string
name?: string
description?: string

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[DELETE]/cm4all-wp-impex/v1/export/{id}

  • Security
    basic

Parameters(Query)

force?: string

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[GET]/cm4all-wp-impex/v1/export/{id}/slice

  • Security
    basic

Parameters(Query)

context?: string[]
page?: string
per_page?: string
offset?: string

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[GET]/cm4all-wp-impex/v1/import/schema

  • Security
    basic

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[GET]/cm4all-wp-impex/v1/import

  • Security
    basic

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[POST]/cm4all-wp-impex/v1/import

  • Security
    basic

RequestBody

  • multipart/form-data
{
  // The options used to create the import.
  options?: string
  // The name of the import profile to use.
  profile?: string
  // The name of the import
  name?: string
  // The description of the import
  description?: string
}

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[GET]/cm4all-wp-impex/v1/import/{id}

  • Security
    basic

Parameters(Query)

context?: string

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[POST]/cm4all-wp-impex/v1/import/{id}

  • Security
    basic

RequestBody

  • multipart/form-data
{
  // The options used to create the import.
  options?: string
  // The name of the import profile to use.
  profile?: string
  // The name of the import
  name?: string
  // The description of the import
  description?: string
}

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[PUT]/cm4all-wp-impex/v1/import/{id}

  • Security
    basic

Parameters(Query)

options?: string
profile?: string
name?: string
description?: string

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[PATCH]/cm4all-wp-impex/v1/import/{id}

  • Security
    basic

Parameters(Query)

options?: string
profile?: string
name?: string
description?: string

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[DELETE]/cm4all-wp-impex/v1/import/{id}

  • Security
    basic

Parameters(Query)

force?: string

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[POST]/cm4all-wp-impex/v1/import/{id}/slice

  • Security
    basic

RequestBody

  • multipart/form-data
{
  // slice position column in database
  position: string
}

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[POST]/cm4all-wp-impex/v1/import/{id}/consume

  • Security
    basic

RequestBody

  • multipart/form-data
{
  // Offset at which to start consuming
  offset?: string
  // Lmit at which to end consuming
  limit?: string
}

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[PUT]/cm4all-wp-impex/v1/import/{id}/consume

  • Security
    basic

Parameters(Query)

offset?: string
limit?: string

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found


[PATCH]/cm4all-wp-impex/v1/import/{id}/consume

  • Security
    basic

Parameters(Query)

offset?: string
limit?: string

Responses

  • 200 OK

  • 400 Bad Request

  • 404 Not Found

References

#/components/requestBodies/postCm4allWpImpexV1Import

  • multipart/form-data
{
  // The options used to create the import.
  options?: string
  // The name of the import profile to use.
  profile?: string
  // The name of the import
  name?: string
  // The description of the import
  description?: string
}

#/components/requestBodies/postCm4allWpImpexV1Export

  • multipart/form-data
{
  // The options used to create the export.
  options?: string
  // The name of the export profile to use.
  profile?: string
  // The human readable name of the export
  name?: string
  // The human readable description of the export
  description?: string
}

#/components/securitySchemes/basic

{
  "type": "http",
  "scheme": "basic"
}