MediaPulse REST API ems.com

MediaPulse REST API

Introduction to the MediaPulse REST API

Version 1.0

MediaPulse Rest API Introduction

IMPORTANT! Use of the MediaPulse REST API assumes a good working knowledge of the MediaPulse application and the documents that you are altering with the API.

This introduction is provided as an example of how to utilize the API tools. Full documentation will be made available at a URL endpoint for each MediaPulse document instance. MediaPulse primarily uses two types of documents, Maintenance/Setup and Lists/Query. Each MediaPulse document is a representation of a collection of tables. Each document has a primary table. All sub-tables are children of the primary table, and a sub-table can have more child sub-tables.

The MediaPulse API allows you to develop your own application to create, read, update or delete information in these tables. The MediaPulse REST API is JSON-based, and has Open API (formerly known as Swagger Specification) v3.0 API specifications available in YAML. These specifications can be retrieved as a plain YAML file and are also readily available to be viewed in a browser through the Swagger UI.

Access to the MediaPulse API, available through the Swagger User Interface, will be provided with each installation of MediaPulse, at:

.

Contact Xytech support for the specific URL that will apply to your company (where host_name, port_no , and db_name values will be supplied to you).

Document names can be found in the Sky UI under System > Document Customizations > Search. Find the Document Description of the document you want to work with and then find the `Class Name'. The `Class Name' value is what should appear at the end of the URL. Examples of the `Class Name' include `JmJob' for the Job Maintenance document and `LibMaster' for the Media Asset Maintenance document. When calling up a specific document for the API, Xytech recommends the use of a private/incognito window in your browser to avoid being served a browser-cached document.

The API allows the following actions to take against MediaPulse: 1. Create document (POST) 2. Create sub tables of a document (POST) 3. Get specific document (GET) 4. Get sub tables of a document (GET) 5. Update document (PATCH) 6. Update sub tables of a document (PATCH) 7. Delete Document (DELETE) 8. Query List Documents (GET)

Xytech API

Page 2 of 8

MediaPulse Rest API Introduction

The document displayed here is Media Asset. The topmost table is always the Primary/Main Table of the document. In this case the table name is "Media Asset".

1. Each of the API Operations on the left are clickable. Clicking them opens up more details about the operation ?

The Parameters tab describes in detail all the Keys that can be used to GET(Retrieve) the Media Asset Record.

Xytech API

Page 3 of 8

MediaPulse Rest API Introduction 2. Scrolling down on the GET gives you all the responses available ?

The response section contains the "Data Model" describing each column and its Data Type.

Xytech API

Page 4 of 8

MediaPulse Rest API Introduction

3. Clicking on the PATCH(Update) gives details about the format expected by the API to Update specific columns in a document ?

Xytech API

Page 5 of 8

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download