Predix Asset

Actions

• AddSchema

  Add Schema

  Create or update properties and required fields for a collection.

  Input

  • Schema
    • Collection (text):  Name of the target collection.
    • Raw Object (object):  Sample asset object that will be used as a template to generate schema fields.
    • Properties Object (object):  Object containing field names and type values.  Overlapping fields from Raw Object and Properties Object input are merged and submitted as one properties object for the schema.   Must be formatted: {”“: {“type”: “”}}.
      • e.g. { “model”: { “type”: “string”}, “coordinates”: {“type”: “object”}, “cost”: {“type”: “number”}}.
    • Required (string collection):  list of text of fields that are required fields.

• CheckSchema

  Check Schema

  Check if a schema exists for a collection.

  Input

  • Schema
    • Collection (text): Name of the collection.

  Output

  • Result
    • Exists? (boolean): Result of the check.

• CreateAssets

  Create Assets

  Create one or more collection assets by providing a collection name and array of assets to create.  Warning: Inputing objects with an existing uri will overwrite existing asset.

  Input

  • Collection
    • Name (text): Name of the target collection.
    • Assets (object collection):  List of assets to be added to the collection.  Each asset must contain a “uri” field and value.  Value must have matching collection name: “//”.  (e.g. “/exampleCollection/1”).

• DeleteAsset

  Delete Asset

  Delete a collection asset.

  Input

  • Asset
    • Asset URI (text):  URI of the asset to be deleted. (e.g. “/sampleCollection/1”)

• DeleteSchema

  Delete Schema

  Delete the schema of a collection.

  Input Fields

  • Schema
    • Collection (text): Name of the collection the schema will be removed from.

• GetNewAccessToken

  Get New Access Token

  Generate a new access token.  If auth expires a new access token must be generated and input into reauthorization of an account.

  Output

  • User
    • Access Token (text): The newly generated access token from the user’s credentials.

• PatchAsset

  Patch Asset

  Patch a collection asset with an array of JSON patch operation objects.  See Link for more info.

  Input

  • Asset
    • Asset URI (text): URI of the asset to be patched.
    • Patch (object collection):  List of patch operations for the target asset.

• ReadAllCollections

  Read All Collections

  Get a listing of user-defined domain asset collections.

  Output

  • Results
    • Collections (object collection): A collection of objects with the name of the collection and the asset count.

• ReadAsset

  Read Asset

  Get a single domain asset by URI

  Options

  • Asset Output Fields (dropdown)
    • Raw Object (option):  Returns the asset in object form with all fields.
    • Schema Fields (option):  Returns the field values of an object with fields generated from the collection schema.  Use if a schema exists.
    • First Asset in Collection (option):   Returns the field values of an object with fields generated from the first asset in a collection.  Use if schema does not exist.
  • Collection Name(dropdown):   Name of the Collection the Asset belongs to.

  Output

  • Data
    • Fields Generated Dynamically from Options.

• ReadSchema

  Read Schema

  Get Schema properties and required fields of a collection.

  Input

  • Schema
    • Collection (text): Name of the target collection.

  Output

  • Schema
    • Type (text): Asset Type.
    • Properties (object): Object containing keys of the asset as fields and the value containing validation information for the field.
    • Required (string collection): List of required fields for an asset.

• ReadCollection

  Read Collection

  Get all assets in a collection.

  Input

  • Collection
    • Name (text): Name of the target collection.
  • GEL Filter
    • Query (text): Filter requested assets using Graph Express Language syntax.  Can also be used to return only requested fields.  For more information visit: GEL Syntax

  Output

  • Results
    • Assets (object collection):  A list of all assets in a collection or all assets that pass the GEL filter in a collection.

• UpdateAsset

  Update Asset

  Uses the PUT method to update a single domain object. All values for the object should be included in the request.  All previous values will be overwritten.

  Input

  • Asset
    • Asset URI(text): URI of the target asset.
    • Asset Object (object):  Object used to overwrite original values.  Asset must contain matching “uri” value.