Skip to end of metadata
Go to start of metadata

Introduction

Phunware’s Content Management module is used to supply your applications with the rich content that sells your brand and engages your app users.  The CM module allows you to configure schemas, create structures around the schemas, and enter content into those structures.

 This guide provides you with details about the underlying APIs that make the data calls for the Content Management Module.

Content Management is part of Phunware’s Core SDK.

Content Management References:


CM API Endpoints and Methods Summary

Create a Structure

 

API Endpoint Category

Methods

Description

HTTP Methods

Breadcrumbs

Retrieve Breadcrumb Path

Retrieves and displays the user’s pathway through the section of the CM module in MaaS.

When a user moves from one section to another (i.e. Structure to Content) or between modules (i.e CM to Mapping), the breadcrumbs are reset.

GET

Schema

Create a Schema

Saves a new schema record and makes it available in the org’s schema list.

POST

Retrieve a Collection of Schemas

Retrieves and displays a list of schemas belonging to the org when a user opens the Content Management Module’s Schema section.

GET

Retrieve a Schema

Retrieves and displays the details of a schema when a user selects it from the list to view or edit.

GET

Update a Schema

Updates a schema record after it has been edited.

PUT

Delete a Schema

Removes a schema record from the org, so it is no longer retrieved with the collection.

This is only allowed if the schema has not been added to a structure.

DELETE

Structures

 

Create a Structure

Saves a new structure record with its associated schema-structures to a container.

GET

Retrieve a Collection of Structures

Retrieves and displays a list of structures belonging to a container when a user opens a container in the Content Management Module’s Structure and Content sections.

POST

Retrieve a Structure

Retrieves and displays the details of a structure when a user selects it from the structure list in a container.

GET

Is Structure Exportable

Checks the requirements for exportable structures. If the structure is exportable the import/export options are made accessible.GET

Reorder Structures

Sorts the structure lists in a container.PUT

Update a Structure

Updates a structure record after it has been edited.

GET

Delete a Structure

Removes a structure a container. This is only allowed when content has not been added to the associated schema-structures.

PUT

Containers

Create Container

Saves a new container record with its associated structures and schema-structures to the org.

DELETE

Retrieve a Collection of Containers

Retrieves and displays a list of containers belonging to the org when a user opens the Content Management Module’s Structure and Content sections.

GET

Retrieve a Container

Retrieves and displays the details of a container when a user selects it from the Container list in the Content Management Module’s Structure and Content sections to view or edit.

GET

Update a Container

Updates a container record after it has been edited.

PUT

Clone a Container

Adds a container record to the database with the identical structures, schema-structures, and optionally content as the selected container record.  (Container name must be changed to be unique for the org.)

POST

Retrieve Cloning Process Status

Retrieves and displays when the container cloning process request is sent and when the response is received so those statuses may be displayed in messages to the user.

GET

Delete a Container

Removes a container record from the display.

This is only allowed when the container  has not been added to the associated schema-structures.

DELETE

Content

Create Content

Saves one or more new content records to a container/structure.

POST

Export ContentExports the content records from a schema structure to a .csv file if importable/exportable requirements are met.GET
Generate Export TokenCreates a one-time use token to enable the export of content records from a schema structure to a .csv file POST
Export Content with TokenExports content records from a schema structure to a .csv file without Authorization HeadersGET
Import Content via CSV

Imports content records from a .csv file to a container's schema-structure.

NOTE: Importing replaces all of the current records for the schema-structure.

PUT

Retrieve Content

Retrieves and displays content details of a content record selected from a list of content records in a schema-structure in the Content Management Module’s Content section to view or edit.

GET

Retrieve Content by ID and Field

Retrieves the content based on the structure hierarchy and schema-content. The structure of the response data for this method relies completely on the structure of the menus and schemas.

Traversal will begin at the content item with the specified [id] AND [field].

GET

Retrieve Content by Field

Retrieves the content based on the structure hierarchy and schema-content. The structure of the response data for this method relies completely on the structure of the menus and schemas.

Traversal will begin at the content item with the specified [field].

GET

Retrieve Content by ID

Retrieves the content based on the structure hierarchy and schema-content. The structure of the response data for this method relies completely on the structure of the menus and schemas.

Traversal will begin at the content item with the specified [id].

GET

Retrieve Content Count by ID and Field

Retrieves the number of content records in a schema-structure hierarchy .

Traversal will begin at the content item with the specified [id] AND [field].

GET

Retrieve Content Count by Field

Retrieves the number of content records in a schema-structure hierarchy .

Traversal will begin at the content item with the specified [field].

GET

Update Content

Updates a Content record after it has been edited.PUT

Delete Content

Removes a content record from the schema-structure.


DELETE

Search Content

Retrieves content records that meet the input search criteria.

GET

Files/S3 Methods

Upload a File

Upload files and returns a URL for use in CME. The file schema field type for content requires a URL, so you must use this endpoint before saving/updating file content.

NOTE: This request must be a multipart/form-data for the file to be uploaded. Please search for how to complete a multipart/form-data request in your framework/programming language.

POST

Replace a File

Replaces previously uploaded files and returns the new URL for use in CM. The file schema field type for content requires a URL, so you must use this endpoint before saving/updating file content.

NOTE: This request must be a multipart/form-data for the file to be uploaded. Please search for how to complete a multipart/form-data request in your framework/programming language.

PUT

Delete a File

 Deletes files previously uploaded through the upload and replace endpoints

DELETE

  • No labels