Trendsic Platform Service

<back to all web services

IntegrationsActionRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/integrations/{Provider}/{Action}

export class ProviderView
{
    public Key: string;
    public Name: string;
    public Category: string;
    public Blurb: string;
    public Mono: string;
    public AuthMode: string;
    public Available: boolean;
    public Status: string;
    public Health: string;
    public StatusDetail: string;
    public AccountLabel: string;
    public Environment: string;
    public LastActivityAt?: string;
    public ManageRoute: string;
    public Actions: string[] = [];

    public constructor(init?: Partial<ProviderView>) { (Object as any).assign(this, init); }
}

export class IntegrationsActionResponse
{
    public Ok: boolean;
    public Message: string;
    public Url: string;
    public Provider: ProviderView;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<IntegrationsActionResponse>) { (Object as any).assign(this, init); }
}

export class IntegrationsActionRequest
{
    public Provider: string;
    public Action: string;
    public ApiKey: string;
    public FromDate: string;
    public ToDate: string;

    public constructor(init?: Partial<IntegrationsActionRequest>) { (Object as any).assign(this, init); }
}

TypeScript IntegrationsActionRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/integrations/{Provider}/{Action} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Provider: String,
	Action: String,
	ApiKey: String,
	FromDate: String,
	ToDate: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Ok: False,
	Message: String,
	Url: String,
	Provider: 
	{
		Key: String,
		Name: String,
		Category: String,
		Blurb: String,
		Mono: String,
		AuthMode: String,
		Available: False,
		Status: String,
		Health: String,
		StatusDetail: String,
		AccountLabel: String,
		Environment: String,
		LastActivityAt: 0001-01-01,
		ManageRoute: String,
		Actions: 
		[
			String
		]
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}