List Media-libraries

GET /media-library
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/media-library

Returns the list of company related media existing in Ocamba

query Parameters
Arrow
Name
Description
viewstring
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.


Example: view=full/default
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,filed2
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string 'sou'.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string 'sou'

See tips for the list of searchable parameters.
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ media-library ]
An array of all created items.
Media Library
Name
Description
app_idstring
A unique application identifier generated by the Ocamba platform.


Example: 1000123
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 1000123
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
heightinteger
Available only for image mime types, represent height of image in pixels.


Example: 300
idstring
A unique identifier generated by the Ocamba platform.


Example: 12
locationstring (url)
Url location where file is stored.


Example: https://sm.ocmcore.com/share/6191234/adex/media/3945083025-example.png
mime_typestring
Mime type of the file.


Example: image/jpeg
namestring
Name of the file.


Example: example
sizeinteger
Size of file in bytes.


Example: 4356
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
user_idstring
A unique user identifier generated by the Ocamba platform.


Example: 1123143
widthinteger
Available only for image mime types, represent width of image in pixels.


Example: 300
totalinteger
A total number of items.


Example: 30
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 30,
  "items": [
    {
        "id": "124",
        "company_id": "6123120",
        "app_id": "1001",
        "user_id": "1001277",
        "location": "https://sm.ocmcore.com/share/6123120/adex/media/16919029-joda.jpeg",
        "name": "joda.jpeg",
        "size": 193302,
        "mime_type": "image/jpeg",
        "width": 1200,
        "height": 900,
        "create_time": "2022-03-28 08:36:19",
        "update_time": "2022-03-28 08:36:19"
    },
    {
        "id": "123",
        "company_id": "6123120",
        "app_id": "1001",
        "user_id": "1001277",
        "location": "https://sm.ocmcore.com/share/6123120/adex/media/1255776809-rick.jpeg",
        "name": "rick.jpeg",
        "size": 5020,
        "mime_type": "image/jpeg",
        "width": 200,
        "height": 200,
        "create_time": "2022-03-28 08:35:59",
        "update_time": "2022-03-28 08:35:59"
    },
    {
        "id": "122",
        "company_id": "6123120",
        "app_id": "1001",
        "user_id": "1001277",
        "location": "https://sm.ocmcore.com/share/6123120/adex/media/3846873605-test1234.png",
        "name": "test1234.png",
        "size": 41236,
        "mime_type": "image/png",
        "width": 400,
        "height": 479,
        "create_time": "2022-03-28 08:35:32",
        "update_time": "2022-03-28 08:35:32"
    }
  ]
}

{
  "total": 30,
  "items": [
    {
      "id": "12",
      "company_id": "1000123",
      "app_id": "1000123",
      "user_id": "1123143",
      "location": "https://sm.ocmcore.com/share/6191234/adex/media/3945083025-example.png",
      "name": "example",
      "mime_type": "image/jpeg",
      "size": 4356,
      "width": 300,
      "height": 300,
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}