List File Records

Pending

GET

https://api.mpc.dev.placewise.com/v1/files

API Permit:Files:Api:Files:List

API Context:Customers

Authorizations:UserToken

Returns list of file records.

Query Parameters

Parameter	Type	Default	Description
per_page	integer	100	Number of results to be returned per request (100 is the maximum)
page_no	integer	1	Number of results page
ids	integer[]	null	When given, returned file records are filtered by id
file_identifiers	string[]	null	When given, returned file records are filtered by file's type & identifier. Format: `#{type}:#{identifier}`.
with_inactive	boolean	false	When true fetches also inactive file records

Example

When successful, returns object containing file record

{
  "file_records": {} // see: FileRecord model
}

Request

Header Params

Body Params application/json

Example

{
    "ids": [
        0
    ],
    "file_identifiers": [
        "string"
    ],
    "file_type": "string",
    "with_inactive": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby

curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/files' \
--header 'X-User-Agent: ApiDog' \
--header 'X-Product-Name: default' \
--header 'X-Loyalty-Club-Slug: infinity-mall' \
--header 'X-Customer: 447' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: ' \
--header 'Content-Type: application/json' \
--data '{
    "ids": [
        0
    ],
    "file_identifiers": [
        "string"
    ],
    "file_type": "string",
    "with_inactive": true
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "file_records": {
        "id": 0,
        "type": "string",
        "identifier": "string",
        "sub_identifier": "string",
        "customer_id": 0,
        "loyalty_club_id": 0,
        "user_id": "string",
        "url": null,
        "filename": "string",
        "mime_type": "string",
        "size": 0,
        "created_at": "string",
        "updated_at": "string",
        "active": true,
        "last_active_at": null,
        "duplicated_from_file_record_id": null
    }
}

Upload from URL

Destroy File Records

List File Records

Query Parameters#

Example#

Request

Request Code Samples

Responses

Query Parameters

Example