getcases

Documentation

Overview

* BSD 3-Clause License * Copyright © 2020. TIBCO Software Inc. * This file is subject to the license terms contained * in the license file that is distributed with this file.

* BSD 3-Clause License * Copyright © 2020. TIBCO Software Inc. * This file is subject to the license terms contained * in the license file that is distributed with this file.

Index

• func New(ctx activity.InitContext) (activity.Activity, error)
• type Activity
  • func (a *Activity) Eval(ctx activity.Context) (done bool, err error)
  • func (a *Activity) Metadata() *activity.Metadata
• type Input
  • func (i *Input) FromMap(values map[string]interface{}) error
  • func (i *Input) ToMap() map[string]interface{}
• type Output
  • func (o *Output) FromMap(values map[string]interface{}) error
  • func (o *Output) ToMap() map[string]interface{}
• type Settings

Functions

func New

func New(ctx activity.InitContext) (activity.Activity, error)

New function for the activity

Types

type Activity

type Activity struct {
	// contains filtered or unexported fields
}

Activity is an activity that is used to invoke a REST Operation

func (*Activity) Eval

func (a *Activity) Eval(ctx activity.Context) (done bool, err error)

Eval implements api.Activity.Eval - Create the hash

func (*Activity) Metadata

func (a *Activity) Metadata() *activity.Metadata

Metadata for the activity

type Input

type Input struct {
	Region      string                 `md:"region"`      //
	Cookie      map[string]interface{} `md:"cookie"`      // TIBCO Cloud cookie
	AccessToken string                 `md:"accessToken"` // AccessToken for Outh 2.0
	SandboxID   string                 `md:"sandboxd"`
	Filter      string                 `md:"filter"` // A filter expression that defines the Types to be returned. The expression can contain one of the following operands: applicationId (eq and in), applicationName (eq) and isCase (eq)
	Select      string                 `md:"select"` // A comma-separated list of identifiers defining the properties to be returned for each Type. If $select is not specified, all properties are returned. Possible values are: b, a, sa, s, js, c, ac
	Skip        string                 `md:"skip"`   // The number of items to exclude from the results list, counting from the beginning of the list. The value must be 0 or greater. For example, $skip=80 results in the first 80 items in the results list being ignored. Subsequent items are returned, starting with the 81st item in the list.
	Top         string                 `md:"top"`    // The maximum number of items to be returned from the results list (with the first item determined by the value of the $skip parameter). The value of $top must be between 1 and 1000. For example, $top=20 returns 20 items from the results list, or all the results if the list contains 20 or fewer items.
	Search      string                 `md:"search"` // Limits results to just those that match the given search string. Only attributes that are defined as ‘Searchable’ in Live Apps Designer are searched.
	Count       bool                   `md:"count"`  // If set to 'TRUE’, returns the number of Types in the result, rather than the Types themselves.
}

Input for the activity

func (*Input) FromMap

func (i *Input) FromMap(values map[string]interface{}) error

FromMap for input

func (*Input) ToMap

func (i *Input) ToMap() map[string]interface{}

ToMap for Input

type Output

type Output struct {
	GetCaseResponseItem []casemanagement.GetCaseResponseItem `md:"getCaseResponseItem"`
}

Output for the activity

func (*Output) FromMap

func (o *Output) FromMap(values map[string]interface{}) error

FromMap convert to object

func (*Output) ToMap

func (o *Output) ToMap() map[string]interface{}

ToMap conver to object

type Settings

type Settings struct {
	Security string `md:"security"`
}

Settings for the activity