SaaS Management Front Service

Application Integration Config

IndexIntegrationConfigurations

List integration configurations.

Retrieves a collection of integration configurations.


/saas/v1/orgs/{orgId}/integration-configurations

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/integration-configurations?filter=&orderBy=&skipToken=&paginationLimit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationIntegrationConfigApi;

import java.io.File;
import java.util.*;

public class ApplicationIntegrationConfigApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ApplicationIntegrationConfigApi apiInstance = new ApplicationIntegrationConfigApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | An application id filter to query the integration configurations. Supported fields in the filter are [applicationId]
        String orderBy = orderBy_example; // String | The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt].
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        try {
            IntegrationConfigurations result = apiInstance.application_Integration_ConfigIndexIntegrationConfigurations(orgId, filter, orderBy, skipToken, paginationLimit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationIntegrationConfigApi#application_Integration_ConfigIndexIntegrationConfigurations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationIntegrationConfigApi;

public class ApplicationIntegrationConfigApiExample {

    public static void main(String[] args) {
        ApplicationIntegrationConfigApi apiInstance = new ApplicationIntegrationConfigApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | An application id filter to query the integration configurations. Supported fields in the filter are [applicationId]
        String orderBy = orderBy_example; // String | The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt].
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        try {
            IntegrationConfigurations result = apiInstance.application_Integration_ConfigIndexIntegrationConfigurations(orgId, filter, orderBy, skipToken, paginationLimit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationIntegrationConfigApi#application_Integration_ConfigIndexIntegrationConfigurations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given Id.
String *filter = filter_example; // An application id filter to query the integration configurations. Supported fields in the filter are [applicationId] (optional)
String *orderBy = orderBy_example; // The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt]. (optional) (default to createdAt desc)
String *skipToken = skipToken_example; // Used in pagination to point to the next set of records. (optional)
String *paginationLimit = paginationLimit_example; // Custom pagination limit to be used. (optional)

ApplicationIntegrationConfigApi *apiInstance = [[ApplicationIntegrationConfigApi alloc] init];

// List integration configurations.
[apiInstance application_Integration_ConfigIndexIntegrationConfigurationsWith:orgId
    filter:filter
    orderBy:orderBy
    skipToken:skipToken
    paginationLimit:paginationLimit
              completionHandler: ^(IntegrationConfigurations output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ApplicationIntegrationConfigApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given Id.
var opts = { 
  'filter': filter_example, // {{String}} An application id filter to query the integration configurations. Supported fields in the filter are [applicationId]
  'orderBy': orderBy_example, // {{String}} The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt].
  'skipToken': skipToken_example, // {{String}} Used in pagination to point to the next set of records.
  'paginationLimit': paginationLimit_example // {{String}} Custom pagination limit to be used.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.application_Integration_ConfigIndexIntegrationConfigurations(orgId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class application_Integration_ConfigIndexIntegrationConfigurationsExample
    {
        public void main()
        {


            var apiInstance = new ApplicationIntegrationConfigApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given Id.
            var filter = filter_example;  // String | An application id filter to query the integration configurations. Supported fields in the filter are [applicationId] (optional) 
            var orderBy = orderBy_example;  // String | The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt]. (optional)  (default to createdAt desc)
            var skipToken = skipToken_example;  // String | Used in pagination to point to the next set of records. (optional) 
            var paginationLimit = paginationLimit_example;  // String | Custom pagination limit to be used. (optional) 

            try
            {
                // List integration configurations.
                IntegrationConfigurations result = apiInstance.application_Integration_ConfigIndexIntegrationConfigurations(orgId, filter, orderBy, skipToken, paginationLimit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationIntegrationConfigApi.application_Integration_ConfigIndexIntegrationConfigurations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiApplicationIntegrationConfigApi();
$orgId = orgId_example; // String | orgId identifies an organization by given Id.
$filter = filter_example; // String | An application id filter to query the integration configurations. Supported fields in the filter are [applicationId]
$orderBy = orderBy_example; // String | The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt].
$skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
$paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.

try {
    $result = $api_instance->application_Integration_ConfigIndexIntegrationConfigurations($orgId, $filter, $orderBy, $skipToken, $paginationLimit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationIntegrationConfigApi->application_Integration_ConfigIndexIntegrationConfigurations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationIntegrationConfigApi;


my $api_instance = WWW::SwaggerClient::ApplicationIntegrationConfigApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given Id.
my $filter = filter_example; # String | An application id filter to query the integration configurations. Supported fields in the filter are [applicationId]
my $orderBy = orderBy_example; # String | The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt].
my $skipToken = skipToken_example; # String | Used in pagination to point to the next set of records.
my $paginationLimit = paginationLimit_example; # String | Custom pagination limit to be used.

eval { 
    my $result = $api_instance->application_Integration_ConfigIndexIntegrationConfigurations(orgId => $orgId, filter => $filter, orderBy => $orderBy, skipToken => $skipToken, paginationLimit => $paginationLimit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationIntegrationConfigApi->application_Integration_ConfigIndexIntegrationConfigurations: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ApplicationIntegrationConfigApi()
orgId = orgId_example # String | orgId identifies an organization by given Id.
filter = filter_example # String | An application id filter to query the integration configurations. Supported fields in the filter are [applicationId] (optional)
orderBy = orderBy_example # String | The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt]. (optional) (default to createdAt desc)
skipToken = skipToken_example # String | Used in pagination to point to the next set of records. (optional)
paginationLimit = paginationLimit_example # String | Custom pagination limit to be used. (optional)

try: 
    # List integration configurations.
    api_response = api_instance.application_integration_config_index_integration_configurations(orgId, filter=filter, orderBy=orderBy, skipToken=skipToken, paginationLimit=paginationLimit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationIntegrationConfigApi->application_Integration_ConfigIndexIntegrationConfigurations: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given Id.
Required
Query parameters
Name Description
filter
String
An application id filter to query the integration configurations. Supported fields in the filter are [applicationId]
orderBy
String
The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt].
skipToken
String
Used in pagination to point to the next set of records.
paginationLimit
String
Custom pagination limit to be used.

Responses

Status: 200 - OK response.

{"nextPage":"/orgs/123/apps/345/integration-configurations?skipToken=b2NjdXJyZWQgZ3QgJzE5NzAtMDEtMDFUMDA6MDA6MDBaJyNvY2N1cnJlZCBkZXNjIzEjNTU2NDg5MDgz","values":[{"applicationId":"123","createdAt":"2018-05-16T16:31:52.1000Z","customFields":"[{\"label\": \"Url\", \"settingsKey\": \"url\"}, {\"label\": \"Apikey\", \"settingsKey\": \"apikey\"}]","extendedSettings":"{\"exchangeType\": \"headers\"}","facets":[{"data":[{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"}],"field":"subAppName"},{"data":[{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"}],"field":"subAppName"}],"groupTaskRequired":true,"imageUrl":"4d87457b19ec858bfafdf0b9f3eccb4cc16d7e0f.png","integrationAuthTypeId":"OAuth2 Client Credentials","integrationPackageName":"metasaas-integration-okta-2.2.6.jar","integrationQueue":"embedded-loader-fsm-production.fifo","isUserMatchingEnabled":true,"settings":"[{\"label\": \"Your Purchaser's Email\", \"settingsKey\": \"username\"}, {\"label\": \"Your Password\", \"settingsKey\": \"password\"}]"},{"applicationId":"123","createdAt":"2018-05-16T16:31:52.1000Z","customFields":"[{\"label\": \"Url\", \"settingsKey\": \"url\"}, {\"label\": \"Apikey\", \"settingsKey\": \"apikey\"}]","extendedSettings":"{\"exchangeType\": \"headers\"}","facets":[{"data":[{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"}],"field":"subAppName"},{"data":[{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"}],"field":"subAppName"}],"groupTaskRequired":true,"imageUrl":"4d87457b19ec858bfafdf0b9f3eccb4cc16d7e0f.png","integrationAuthTypeId":"OAuth2 Client Credentials","integrationPackageName":"metasaas-integration-okta-2.2.6.jar","integrationQueue":"embedded-loader-fsm-production.fifo","isUserMatchingEnabled":true,"settings":"[{\"label\": \"Your Purchaser's Email\", \"settingsKey\": \"username\"}, {\"label\": \"Your Password\", \"settingsKey\": \"password\"}]"}]}

Status: 400 - Bad Request response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

IndexIntegrationTasks

List integration tasks.

Retrieves a collection of integration tasks.


/saas/v1/orgs/{orgId}/integration-tasks

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/integration-tasks?filter=&orderBy=&skipToken=&paginationLimit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationIntegrationConfigApi;

import java.io.File;
import java.util.*;

public class ApplicationIntegrationConfigApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ApplicationIntegrationConfigApi apiInstance = new ApplicationIntegrationConfigApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | An integration task name filter to query the integration tasks. Supported fields in the filter are [name, applicationId]
        String orderBy = orderBy_example; // String | The order by filter to sort the integration tasks. Supported fields in the orderBy are [createdAt].
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        try {
            IntegrationTasks result = apiInstance.application_Integration_ConfigIndexIntegrationTasks(orgId, filter, orderBy, skipToken, paginationLimit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationIntegrationConfigApi#application_Integration_ConfigIndexIntegrationTasks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationIntegrationConfigApi;

public class ApplicationIntegrationConfigApiExample {

    public static void main(String[] args) {
        ApplicationIntegrationConfigApi apiInstance = new ApplicationIntegrationConfigApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | An integration task name filter to query the integration tasks. Supported fields in the filter are [name, applicationId]
        String orderBy = orderBy_example; // String | The order by filter to sort the integration tasks. Supported fields in the orderBy are [createdAt].
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        try {
            IntegrationTasks result = apiInstance.application_Integration_ConfigIndexIntegrationTasks(orgId, filter, orderBy, skipToken, paginationLimit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationIntegrationConfigApi#application_Integration_ConfigIndexIntegrationTasks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given Id.
String *filter = filter_example; // An integration task name filter to query the integration tasks. Supported fields in the filter are [name, applicationId] (optional)
String *orderBy = orderBy_example; // The order by filter to sort the integration tasks. Supported fields in the orderBy are [createdAt]. (optional) (default to createdAt desc)
String *skipToken = skipToken_example; // Used in pagination to point to the next set of records. (optional)
String *paginationLimit = paginationLimit_example; // Custom pagination limit to be used. (optional)

ApplicationIntegrationConfigApi *apiInstance = [[ApplicationIntegrationConfigApi alloc] init];

// List integration tasks.
[apiInstance application_Integration_ConfigIndexIntegrationTasksWith:orgId
    filter:filter
    orderBy:orderBy
    skipToken:skipToken
    paginationLimit:paginationLimit
              completionHandler: ^(IntegrationTasks output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ApplicationIntegrationConfigApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given Id.
var opts = { 
  'filter': filter_example, // {{String}} An integration task name filter to query the integration tasks. Supported fields in the filter are [name, applicationId]
  'orderBy': orderBy_example, // {{String}} The order by filter to sort the integration tasks. Supported fields in the orderBy are [createdAt].
  'skipToken': skipToken_example, // {{String}} Used in pagination to point to the next set of records.
  'paginationLimit': paginationLimit_example // {{String}} Custom pagination limit to be used.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.application_Integration_ConfigIndexIntegrationTasks(orgId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class application_Integration_ConfigIndexIntegrationTasksExample
    {
        public void main()
        {


            var apiInstance = new ApplicationIntegrationConfigApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given Id.
            var filter = filter_example;  // String | An integration task name filter to query the integration tasks. Supported fields in the filter are [name, applicationId] (optional) 
            var orderBy = orderBy_example;  // String | The order by filter to sort the integration tasks. Supported fields in the orderBy are [createdAt]. (optional)  (default to createdAt desc)
            var skipToken = skipToken_example;  // String | Used in pagination to point to the next set of records. (optional) 
            var paginationLimit = paginationLimit_example;  // String | Custom pagination limit to be used. (optional) 

            try
            {
                // List integration tasks.
                IntegrationTasks result = apiInstance.application_Integration_ConfigIndexIntegrationTasks(orgId, filter, orderBy, skipToken, paginationLimit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationIntegrationConfigApi.application_Integration_ConfigIndexIntegrationTasks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiApplicationIntegrationConfigApi();
$orgId = orgId_example; // String | orgId identifies an organization by given Id.
$filter = filter_example; // String | An integration task name filter to query the integration tasks. Supported fields in the filter are [name, applicationId]
$orderBy = orderBy_example; // String | The order by filter to sort the integration tasks. Supported fields in the orderBy are [createdAt].
$skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
$paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.

try {
    $result = $api_instance->application_Integration_ConfigIndexIntegrationTasks($orgId, $filter, $orderBy, $skipToken, $paginationLimit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationIntegrationConfigApi->application_Integration_ConfigIndexIntegrationTasks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationIntegrationConfigApi;


my $api_instance = WWW::SwaggerClient::ApplicationIntegrationConfigApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given Id.
my $filter = filter_example; # String | An integration task name filter to query the integration tasks. Supported fields in the filter are [name, applicationId]
my $orderBy = orderBy_example; # String | The order by filter to sort the integration tasks. Supported fields in the orderBy are [createdAt].
my $skipToken = skipToken_example; # String | Used in pagination to point to the next set of records.
my $paginationLimit = paginationLimit_example; # String | Custom pagination limit to be used.

eval { 
    my $result = $api_instance->application_Integration_ConfigIndexIntegrationTasks(orgId => $orgId, filter => $filter, orderBy => $orderBy, skipToken => $skipToken, paginationLimit => $paginationLimit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationIntegrationConfigApi->application_Integration_ConfigIndexIntegrationTasks: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ApplicationIntegrationConfigApi()
orgId = orgId_example # String | orgId identifies an organization by given Id.
filter = filter_example # String | An integration task name filter to query the integration tasks. Supported fields in the filter are [name, applicationId] (optional)
orderBy = orderBy_example # String | The order by filter to sort the integration tasks. Supported fields in the orderBy are [createdAt]. (optional) (default to createdAt desc)
skipToken = skipToken_example # String | Used in pagination to point to the next set of records. (optional)
paginationLimit = paginationLimit_example # String | Custom pagination limit to be used. (optional)

try: 
    # List integration tasks.
    api_response = api_instance.application_integration_config_index_integration_tasks(orgId, filter=filter, orderBy=orderBy, skipToken=skipToken, paginationLimit=paginationLimit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationIntegrationConfigApi->application_Integration_ConfigIndexIntegrationTasks: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given Id.
Required
Query parameters
Name Description
filter
String
An integration task name filter to query the integration tasks. Supported fields in the filter are [name, applicationId]
orderBy
String
The order by filter to sort the integration tasks. Supported fields in the orderBy are [createdAt].
skipToken
String
Used in pagination to point to the next set of records.
paginationLimit
String
Custom pagination limit to be used.

Responses

Status: 200 - OK response.

{"nextPage":"/orgs/123/apps/345/integration-tasks?skipToken=b2NjdXJyZWQgZ3QgJzE5NzAtMDEtMDFUMDA6MDA6MDBaJyNvY2N1cnJlZCBkZXNjIzEjNTU2NDg5MDgz","values":[{"Id":"123","applicationId":"123","availableSettings":"[{\"key\": \"department\", \"type\": \"boolean\", \"default\": \"true\", \"displayName\": \"Include Departments? (OPTIONAL)\"}, {\"key\": \"location\", \"type\": \"boolean\", \"default\": \"true\", \"displayName\": \"Include City? (OPTIONAL)\"}]","createdAt":"2018-05-16T16:31:52.1000Z","cronExpression":"0 */15 * ? * *","defaultExecutionMinutes":1440,"description":"description","displayName":"Document Access","interfaceName":"com.metasaas.integration.processor.IDocumentAccessTaskProcessor","isActive":true,"isSsoTask":true,"lastModifiedAt":"2018-05-16T16:31:52.1000Z","name":"DOCUMENT_ACCESS"},{"Id":"123","applicationId":"123","availableSettings":"[{\"key\": \"department\", \"type\": \"boolean\", \"default\": \"true\", \"displayName\": \"Include Departments? (OPTIONAL)\"}, {\"key\": \"location\", \"type\": \"boolean\", \"default\": \"true\", \"displayName\": \"Include City? (OPTIONAL)\"}]","createdAt":"2018-05-16T16:31:52.1000Z","cronExpression":"0 */15 * ? * *","defaultExecutionMinutes":1440,"description":"description","displayName":"Document Access","interfaceName":"com.metasaas.integration.processor.IDocumentAccessTaskProcessor","isActive":true,"isSsoTask":true,"lastModifiedAt":"2018-05-16T16:31:52.1000Z","name":"DOCUMENT_ACCESS"},{"Id":"123","applicationId":"123","availableSettings":"[{\"key\": \"department\", \"type\": \"boolean\", \"default\": \"true\", \"displayName\": \"Include Departments? (OPTIONAL)\"}, {\"key\": \"location\", \"type\": \"boolean\", \"default\": \"true\", \"displayName\": \"Include City? (OPTIONAL)\"}]","createdAt":"2018-05-16T16:31:52.1000Z","cronExpression":"0 */15 * ? * *","defaultExecutionMinutes":1440,"description":"description","displayName":"Document Access","interfaceName":"com.metasaas.integration.processor.IDocumentAccessTaskProcessor","isActive":true,"isSsoTask":true,"lastModifiedAt":"2018-05-16T16:31:52.1000Z","name":"DOCUMENT_ACCESS"}]}

Status: 400 - Bad Request response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Import Jobs

CreateManagedAppImportJob

Create import job.

This resource creates an import job for loading data into the managed application. SaaS data objects must be first created before an import job can be submitted.


/saas/v1/orgs/{orgId}/import-jobs

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/vnd.goa.error"\
-H "Content-Type: application/json"\
"http://localhost:80/saas/v1/orgs/{orgId}/import-jobs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ImportJobsApi;

import java.io.File;
import java.util.*;

public class ImportJobsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ImportJobsApi apiInstance = new ImportJobsApi();
        CreateManagedAppImportJobRequestBody body = {
  "importSettings" : {
    "loadType" : "incremental",
    "taskName" : "ApplicationUsage"
  },
  "managedAppId" : "123",
  "saasDataList" : [ {
    "name" : "managed-app_1234_sept-2020.csv.gz"
  }, {
    "name" : "managed-app_1234_sept-2020.csv.gz"
  } ]
}; // CreateManagedAppImportJobRequestBody | 
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        try {
            apiInstance.import_JobsCreateManagedAppImportJob(body, orgId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImportJobsApi#import_JobsCreateManagedAppImportJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImportJobsApi;

public class ImportJobsApiExample {

    public static void main(String[] args) {
        ImportJobsApi apiInstance = new ImportJobsApi();
        CreateManagedAppImportJobRequestBody body = {
  "importSettings" : {
    "loadType" : "incremental",
    "taskName" : "ApplicationUsage"
  },
  "managedAppId" : "123",
  "saasDataList" : [ {
    "name" : "managed-app_1234_sept-2020.csv.gz"
  }, {
    "name" : "managed-app_1234_sept-2020.csv.gz"
  } ]
}; // CreateManagedAppImportJobRequestBody | 
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        try {
            apiInstance.import_JobsCreateManagedAppImportJob(body, orgId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImportJobsApi#import_JobsCreateManagedAppImportJob");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
CreateManagedAppImportJobRequestBody *body = {
  "importSettings" : {
    "loadType" : "incremental",
    "taskName" : "ApplicationUsage"
  },
  "managedAppId" : "123",
  "saasDataList" : [ {
    "name" : "managed-app_1234_sept-2020.csv.gz"
  }, {
    "name" : "managed-app_1234_sept-2020.csv.gz"
  } ]
}; // 
String *orgId = orgId_example; // orgId identifies an organization by given ID.

ImportJobsApi *apiInstance = [[ImportJobsApi alloc] init];

// Create import job.
[apiInstance import_JobsCreateManagedAppImportJobWith:body
    orgId:orgId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ImportJobsApi()
var body = {
  "importSettings" : {
    "loadType" : "incremental",
    "taskName" : "ApplicationUsage"
  },
  "managedAppId" : "123",
  "saasDataList" : [ {
    "name" : "managed-app_1234_sept-2020.csv.gz"
  }, {
    "name" : "managed-app_1234_sept-2020.csv.gz"
  } ]
}; // {{CreateManagedAppImportJobRequestBody}} 
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.import_JobsCreateManagedAppImportJob(bodyorgId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class import_JobsCreateManagedAppImportJobExample
    {
        public void main()
        {


            var apiInstance = new ImportJobsApi();
            var body = new CreateManagedAppImportJobRequestBody(); // CreateManagedAppImportJobRequestBody | 
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.

            try
            {
                // Create import job.
                apiInstance.import_JobsCreateManagedAppImportJob(body, orgId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImportJobsApi.import_JobsCreateManagedAppImportJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiImportJobsApi();
$body = {
  "importSettings" : {
    "loadType" : "incremental",
    "taskName" : "ApplicationUsage"
  },
  "managedAppId" : "123",
  "saasDataList" : [ {
    "name" : "managed-app_1234_sept-2020.csv.gz"
  }, {
    "name" : "managed-app_1234_sept-2020.csv.gz"
  } ]
}; // CreateManagedAppImportJobRequestBody | 
$orgId = orgId_example; // String | orgId identifies an organization by given ID.

try {
    $api_instance->import_JobsCreateManagedAppImportJob($body, $orgId);
} catch (Exception $e) {
    echo 'Exception when calling ImportJobsApi->import_JobsCreateManagedAppImportJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ImportJobsApi;


my $api_instance = WWW::SwaggerClient::ImportJobsApi->new();
my $body = WWW::SwaggerClient::Object::CreateManagedAppImportJobRequestBody->new(); # CreateManagedAppImportJobRequestBody | 
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.

eval { 
    $api_instance->import_JobsCreateManagedAppImportJob(body => $body, orgId => $orgId);
};
if ($@) {
    warn "Exception when calling ImportJobsApi->import_JobsCreateManagedAppImportJob: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ImportJobsApi()
body = {
  "importSettings" : {
    "loadType" : "incremental",
    "taskName" : "ApplicationUsage"
  },
  "managedAppId" : "123",
  "saasDataList" : [ {
    "name" : "managed-app_1234_sept-2020.csv.gz"
  }, {
    "name" : "managed-app_1234_sept-2020.csv.gz"
  } ]
} # CreateManagedAppImportJobRequestBody | 
orgId = orgId_example # String | orgId identifies an organization by given ID.

try: 
    # Create import job.
    api_instance.import_jobs_create_managed_app_import_job(body, orgId)
except ApiException as e:
    print("Exception when calling ImportJobsApi->import_JobsCreateManagedAppImportJob: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created response.

Name Type Format Description
Location String /saas/v1/orgs/123/imports-jobs/abcdefg123 URL for the newly created import job.

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Index

List import jobs.

This endpoint retrieves a list of import jobs. The import jobs may be filtered or ordered by their status.


/saas/v1/orgs/{orgId}/import-jobs

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/import-jobs?filter=&orderBy=&skipToken="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ImportJobsApi;

import java.io.File;
import java.util.*;

public class ImportJobsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ImportJobsApi apiInstance = new ImportJobsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String filter = filter_example; // String | A filter to narrow the number of jobs to return. Supported fields in the filter are [sourceHref, startedAt, completedAt, failedAt, status]
        String orderBy = orderBy_example; // String | The order by to sort the import jobs. Supported fields in the orderBy are [startedAt, completedAt, failedAt]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        try {
            ImportJobList result = apiInstance.import_JobsIndex(orgId, filter, orderBy, skipToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImportJobsApi#import_JobsIndex");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImportJobsApi;

public class ImportJobsApiExample {

    public static void main(String[] args) {
        ImportJobsApi apiInstance = new ImportJobsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String filter = filter_example; // String | A filter to narrow the number of jobs to return. Supported fields in the filter are [sourceHref, startedAt, completedAt, failedAt, status]
        String orderBy = orderBy_example; // String | The order by to sort the import jobs. Supported fields in the orderBy are [startedAt, completedAt, failedAt]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        try {
            ImportJobList result = apiInstance.import_JobsIndex(orgId, filter, orderBy, skipToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImportJobsApi#import_JobsIndex");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given ID.
String *filter = filter_example; // A filter to narrow the number of jobs to return. Supported fields in the filter are [sourceHref, startedAt, completedAt, failedAt, status] (optional)
String *orderBy = orderBy_example; // The order by to sort the import jobs. Supported fields in the orderBy are [startedAt, completedAt, failedAt] (optional) (default to completedAt desc)
String *skipToken = skipToken_example; // Used in pagination to point to the next set of records. (optional)

ImportJobsApi *apiInstance = [[ImportJobsApi alloc] init];

// List import jobs.
[apiInstance import_JobsIndexWith:orgId
    filter:filter
    orderBy:orderBy
    skipToken:skipToken
              completionHandler: ^(ImportJobList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ImportJobsApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.
var opts = { 
  'filter': filter_example, // {{String}} A filter to narrow the number of jobs to return. Supported fields in the filter are [sourceHref, startedAt, completedAt, failedAt, status]
  'orderBy': orderBy_example, // {{String}} The order by to sort the import jobs. Supported fields in the orderBy are [startedAt, completedAt, failedAt]
  'skipToken': skipToken_example // {{String}} Used in pagination to point to the next set of records.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.import_JobsIndex(orgId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class import_JobsIndexExample
    {
        public void main()
        {


            var apiInstance = new ImportJobsApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.
            var filter = filter_example;  // String | A filter to narrow the number of jobs to return. Supported fields in the filter are [sourceHref, startedAt, completedAt, failedAt, status] (optional) 
            var orderBy = orderBy_example;  // String | The order by to sort the import jobs. Supported fields in the orderBy are [startedAt, completedAt, failedAt] (optional)  (default to completedAt desc)
            var skipToken = skipToken_example;  // String | Used in pagination to point to the next set of records. (optional) 

            try
            {
                // List import jobs.
                ImportJobList result = apiInstance.import_JobsIndex(orgId, filter, orderBy, skipToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImportJobsApi.import_JobsIndex: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiImportJobsApi();
$orgId = orgId_example; // String | orgId identifies an organization by given ID.
$filter = filter_example; // String | A filter to narrow the number of jobs to return. Supported fields in the filter are [sourceHref, startedAt, completedAt, failedAt, status]
$orderBy = orderBy_example; // String | The order by to sort the import jobs. Supported fields in the orderBy are [startedAt, completedAt, failedAt]
$skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.

try {
    $result = $api_instance->import_JobsIndex($orgId, $filter, $orderBy, $skipToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImportJobsApi->import_JobsIndex: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ImportJobsApi;


my $api_instance = WWW::SwaggerClient::ImportJobsApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.
my $filter = filter_example; # String | A filter to narrow the number of jobs to return. Supported fields in the filter are [sourceHref, startedAt, completedAt, failedAt, status]
my $orderBy = orderBy_example; # String | The order by to sort the import jobs. Supported fields in the orderBy are [startedAt, completedAt, failedAt]
my $skipToken = skipToken_example; # String | Used in pagination to point to the next set of records.

eval { 
    my $result = $api_instance->import_JobsIndex(orgId => $orgId, filter => $filter, orderBy => $orderBy, skipToken => $skipToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImportJobsApi->import_JobsIndex: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ImportJobsApi()
orgId = orgId_example # String | orgId identifies an organization by given ID.
filter = filter_example # String | A filter to narrow the number of jobs to return. Supported fields in the filter are [sourceHref, startedAt, completedAt, failedAt, status] (optional)
orderBy = orderBy_example # String | The order by to sort the import jobs. Supported fields in the orderBy are [startedAt, completedAt, failedAt] (optional) (default to completedAt desc)
skipToken = skipToken_example # String | Used in pagination to point to the next set of records. (optional)

try: 
    # List import jobs.
    api_response = api_instance.import_jobs_index(orgId, filter=filter, orderBy=orderBy, skipToken=skipToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImportJobsApi->import_JobsIndex: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required
Query parameters
Name Description
filter
String
A filter to narrow the number of jobs to return. Supported fields in the filter are [sourceHref, startedAt, completedAt, failedAt, status]
orderBy
String
The order by to sort the import jobs. Supported fields in the orderBy are [startedAt, completedAt, failedAt]
skipToken
String
Used in pagination to point to the next set of records.

Responses

Status: 200 - OK response.

{"items":[{"createdAt":"2018-05-16T16:31:52.1000Z","errors":[{"error":"Quis beatae et reiciendis.","potentialResolution":"Eveniet repudiandae quas ea quasi.","summary":"Illum quod placeat illo."},{"error":"Quis beatae et reiciendis.","potentialResolution":"Eveniet repudiandae quas ea quasi.","summary":"Illum quod placeat illo."},{"error":"Quis beatae et reiciendis.","potentialResolution":"Eveniet repudiandae quas ea quasi.","summary":"Illum quod placeat illo."}],"finishedAt":"2018-05-16T16:31:52.1000Z","id":"P6VAGLVY6BBKPF5F2TUCQJONPY","importSettings":{"loadType":"full","taskName":"SsoApplicationRoster"},"saasDataList":[{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"},{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"},{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"}],"sourceHref":"saas/v1/orgs/1234/managed-apps/5678","startedAt":"2018-05-16T16:31:52.1000Z","status":"running"},{"createdAt":"2018-05-16T16:31:52.1000Z","errors":[{"error":"Quis beatae et reiciendis.","potentialResolution":"Eveniet repudiandae quas ea quasi.","summary":"Illum quod placeat illo."},{"error":"Quis beatae et reiciendis.","potentialResolution":"Eveniet repudiandae quas ea quasi.","summary":"Illum quod placeat illo."},{"error":"Quis beatae et reiciendis.","potentialResolution":"Eveniet repudiandae quas ea quasi.","summary":"Illum quod placeat illo."}],"finishedAt":"2018-05-16T16:31:52.1000Z","id":"P6VAGLVY6BBKPF5F2TUCQJONPY","importSettings":{"loadType":"full","taskName":"SsoApplicationRoster"},"saasDataList":[{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"},{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"},{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"}],"sourceHref":"saas/v1/orgs/1234/managed-apps/5678","startedAt":"2018-05-16T16:31:52.1000Z","status":"running"},{"createdAt":"2018-05-16T16:31:52.1000Z","errors":[{"error":"Quis beatae et reiciendis.","potentialResolution":"Eveniet repudiandae quas ea quasi.","summary":"Illum quod placeat illo."},{"error":"Quis beatae et reiciendis.","potentialResolution":"Eveniet repudiandae quas ea quasi.","summary":"Illum quod placeat illo."},{"error":"Quis beatae et reiciendis.","potentialResolution":"Eveniet repudiandae quas ea quasi.","summary":"Illum quod placeat illo."}],"finishedAt":"2018-05-16T16:31:52.1000Z","id":"P6VAGLVY6BBKPF5F2TUCQJONPY","importSettings":{"loadType":"full","taskName":"SsoApplicationRoster"},"saasDataList":[{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"},{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"},{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"}],"sourceHref":"saas/v1/orgs/1234/managed-apps/5678","startedAt":"2018-05-16T16:31:52.1000Z","status":"running"},{"createdAt":"2018-05-16T16:31:52.1000Z","errors":[{"error":"Quis beatae et reiciendis.","potentialResolution":"Eveniet repudiandae quas ea quasi.","summary":"Illum quod placeat illo."},{"error":"Quis beatae et reiciendis.","potentialResolution":"Eveniet repudiandae quas ea quasi.","summary":"Illum quod placeat illo."},{"error":"Quis beatae et reiciendis.","potentialResolution":"Eveniet repudiandae quas ea quasi.","summary":"Illum quod placeat illo."}],"finishedAt":"2018-05-16T16:31:52.1000Z","id":"P6VAGLVY6BBKPF5F2TUCQJONPY","importSettings":{"loadType":"full","taskName":"SsoApplicationRoster"},"saasDataList":[{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"},{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"},{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"}],"sourceHref":"saas/v1/orgs/1234/managed-apps/5678","startedAt":"2018-05-16T16:31:52.1000Z","status":"running"}],"nextPage":"/saas/v1/orgs/1/import-jobs?skipToken=b2NjdXJyZWQgZ3QgJzE5NzAtMDEtMDFUMDA6MDA6MDBaJyNvY2N1cnJlZCBkZXNjIzEjNTU2NDg5MDgz"}

Status: 400 - Bad Request response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Show

Show import job.

Retrieves import job identified by ID.


/saas/v1/orgs/{orgId}/import-jobs/{id}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/import-jobs/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ImportJobsApi;

import java.io.File;
import java.util.*;

public class ImportJobsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ImportJobsApi apiInstance = new ImportJobsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String id = id_example; // String | A Base 32 encoded UUID Type 4 identifier for the ImportJob object
        try {
            FlexeraFsmImportjob result = apiInstance.import_JobsShow(orgId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImportJobsApi#import_JobsShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImportJobsApi;

public class ImportJobsApiExample {

    public static void main(String[] args) {
        ImportJobsApi apiInstance = new ImportJobsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String id = id_example; // String | A Base 32 encoded UUID Type 4 identifier for the ImportJob object
        try {
            FlexeraFsmImportjob result = apiInstance.import_JobsShow(orgId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImportJobsApi#import_JobsShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given ID.
String *id = id_example; // A Base 32 encoded UUID Type 4 identifier for the ImportJob object

ImportJobsApi *apiInstance = [[ImportJobsApi alloc] init];

// Show import job.
[apiInstance import_JobsShowWith:orgId
    id:id
              completionHandler: ^(FlexeraFsmImportjob output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ImportJobsApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.
var id = id_example; // {{String}} A Base 32 encoded UUID Type 4 identifier for the ImportJob object

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.import_JobsShow(orgId, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class import_JobsShowExample
    {
        public void main()
        {


            var apiInstance = new ImportJobsApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.
            var id = id_example;  // String | A Base 32 encoded UUID Type 4 identifier for the ImportJob object

            try
            {
                // Show import job.
                FlexeraFsmImportjob result = apiInstance.import_JobsShow(orgId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImportJobsApi.import_JobsShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiImportJobsApi();
$orgId = orgId_example; // String | orgId identifies an organization by given ID.
$id = id_example; // String | A Base 32 encoded UUID Type 4 identifier for the ImportJob object

try {
    $result = $api_instance->import_JobsShow($orgId, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImportJobsApi->import_JobsShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ImportJobsApi;


my $api_instance = WWW::SwaggerClient::ImportJobsApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.
my $id = id_example; # String | A Base 32 encoded UUID Type 4 identifier for the ImportJob object

eval { 
    my $result = $api_instance->import_JobsShow(orgId => $orgId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImportJobsApi->import_JobsShow: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ImportJobsApi()
orgId = orgId_example # String | orgId identifies an organization by given ID.
id = id_example # String | A Base 32 encoded UUID Type 4 identifier for the ImportJob object

try: 
    # Show import job.
    api_response = api_instance.import_jobs_show(orgId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImportJobsApi->import_JobsShow: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required
id*
String
A Base 32 encoded UUID Type 4 identifier for the ImportJob object
Required

Responses

Status: 200 - OK response.

{"createdAt":"2018-05-16T16:31:52.1000Z","errors":[{"error":"Autem aut voluptatem provident atque cum.","potentialResolution":"Et autem accusamus mollitia iure nam.","summary":"Deserunt et quae voluptatem voluptatibus."},{"error":"Autem aut voluptatem provident atque cum.","potentialResolution":"Et autem accusamus mollitia iure nam.","summary":"Deserunt et quae voluptatem voluptatibus."},{"error":"Autem aut voluptatem provident atque cum.","potentialResolution":"Et autem accusamus mollitia iure nam.","summary":"Deserunt et quae voluptatem voluptatibus."}],"finishedAt":"2018-05-16T16:31:52.1000Z","id":"P6VAGLVY6BBKPF5F2TUCQJONPY","importSettings":{"loadType":"full","taskName":"SsoApplicationRoster"},"saasDataList":[{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"},{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"},{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"}],"sourceHref":"saas/v1/orgs/1234/managed-apps/5678","startedAt":"2018-05-16T16:31:52.1000Z","status":"running"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Licenses

Index

List licenses.

Retrieves a collection of licenses.


/saas/v1/orgs/{orgId}/licenses

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/licenses?filter=&orderBy=&skipToken=&paginationLimit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LicensesApi;

import java.io.File;
import java.util.*;

public class LicensesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        LicensesApi apiInstance = new LicensesApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | The date filter to query the licenses. Supported fields in the filter are [createdAt]
        String orderBy = orderBy_example; // String | The order by filter to sort the licenses. Supported values are Supported fields in the orderBy are [createdAt]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        try {
            DenormalizedLicenseAgreements result = apiInstance.licensesIndex(orgId, filter, orderBy, skipToken, paginationLimit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LicensesApi#licensesIndex");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LicensesApi;

public class LicensesApiExample {

    public static void main(String[] args) {
        LicensesApi apiInstance = new LicensesApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | The date filter to query the licenses. Supported fields in the filter are [createdAt]
        String orderBy = orderBy_example; // String | The order by filter to sort the licenses. Supported values are Supported fields in the orderBy are [createdAt]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        try {
            DenormalizedLicenseAgreements result = apiInstance.licensesIndex(orgId, filter, orderBy, skipToken, paginationLimit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LicensesApi#licensesIndex");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given Id.
String *filter = filter_example; // The date filter to query the licenses. Supported fields in the filter are [createdAt] (optional)
String *orderBy = orderBy_example; // The order by filter to sort the licenses. Supported values are Supported fields in the orderBy are [createdAt] (optional) (default to createdAt desc)
String *skipToken = skipToken_example; // Used in pagination to point to the next set of records. (optional)
String *paginationLimit = paginationLimit_example; // Custom pagination limit to be used. (optional)

LicensesApi *apiInstance = [[LicensesApi alloc] init];

// List licenses.
[apiInstance licensesIndexWith:orgId
    filter:filter
    orderBy:orderBy
    skipToken:skipToken
    paginationLimit:paginationLimit
              completionHandler: ^(DenormalizedLicenseAgreements output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.LicensesApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given Id.
var opts = { 
  'filter': filter_example, // {{String}} The date filter to query the licenses. Supported fields in the filter are [createdAt]
  'orderBy': orderBy_example, // {{String}} The order by filter to sort the licenses. Supported values are Supported fields in the orderBy are [createdAt]
  'skipToken': skipToken_example, // {{String}} Used in pagination to point to the next set of records.
  'paginationLimit': paginationLimit_example // {{String}} Custom pagination limit to be used.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.licensesIndex(orgId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class licensesIndexExample
    {
        public void main()
        {


            var apiInstance = new LicensesApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given Id.
            var filter = filter_example;  // String | The date filter to query the licenses. Supported fields in the filter are [createdAt] (optional) 
            var orderBy = orderBy_example;  // String | The order by filter to sort the licenses. Supported values are Supported fields in the orderBy are [createdAt] (optional)  (default to createdAt desc)
            var skipToken = skipToken_example;  // String | Used in pagination to point to the next set of records. (optional) 
            var paginationLimit = paginationLimit_example;  // String | Custom pagination limit to be used. (optional) 

            try
            {
                // List licenses.
                DenormalizedLicenseAgreements result = apiInstance.licensesIndex(orgId, filter, orderBy, skipToken, paginationLimit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LicensesApi.licensesIndex: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiLicensesApi();
$orgId = orgId_example; // String | orgId identifies an organization by given Id.
$filter = filter_example; // String | The date filter to query the licenses. Supported fields in the filter are [createdAt]
$orderBy = orderBy_example; // String | The order by filter to sort the licenses. Supported values are Supported fields in the orderBy are [createdAt]
$skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
$paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.

try {
    $result = $api_instance->licensesIndex($orgId, $filter, $orderBy, $skipToken, $paginationLimit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LicensesApi->licensesIndex: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LicensesApi;


my $api_instance = WWW::SwaggerClient::LicensesApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given Id.
my $filter = filter_example; # String | The date filter to query the licenses. Supported fields in the filter are [createdAt]
my $orderBy = orderBy_example; # String | The order by filter to sort the licenses. Supported values are Supported fields in the orderBy are [createdAt]
my $skipToken = skipToken_example; # String | Used in pagination to point to the next set of records.
my $paginationLimit = paginationLimit_example; # String | Custom pagination limit to be used.

eval { 
    my $result = $api_instance->licensesIndex(orgId => $orgId, filter => $filter, orderBy => $orderBy, skipToken => $skipToken, paginationLimit => $paginationLimit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LicensesApi->licensesIndex: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.LicensesApi()
orgId = orgId_example # String | orgId identifies an organization by given Id.
filter = filter_example # String | The date filter to query the licenses. Supported fields in the filter are [createdAt] (optional)
orderBy = orderBy_example # String | The order by filter to sort the licenses. Supported values are Supported fields in the orderBy are [createdAt] (optional) (default to createdAt desc)
skipToken = skipToken_example # String | Used in pagination to point to the next set of records. (optional)
paginationLimit = paginationLimit_example # String | Custom pagination limit to be used. (optional)

try: 
    # List licenses.
    api_response = api_instance.licenses_index(orgId, filter=filter, orderBy=orderBy, skipToken=skipToken, paginationLimit=paginationLimit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LicensesApi->licensesIndex: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given Id.
Required
Query parameters
Name Description
filter
String
The date filter to query the licenses. Supported fields in the filter are [createdAt]
orderBy
String
The order by filter to sort the licenses. Supported values are Supported fields in the orderBy are [createdAt]
skipToken
String
Used in pagination to point to the next set of records.
paginationLimit
String
Custom pagination limit to be used.

Responses

Status: 200 - OK response.

{"nextPage":"/orgs/123/licenses?skipToken=b2NjdXJyZWQgZ3QgJzE5NzAtMDEtMDFUMDA6MDA6MDBaJyNvY2N1cnJlZCBkZXNjIzEjNTU2NDg5MDgz","values":[{"agreementFees":[{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Quarterly","paymentFrequencyInMonths":6},{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Quarterly","paymentFrequencyInMonths":6},{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Quarterly","paymentFrequencyInMonths":6},{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Quarterly","paymentFrequencyInMonths":6}],"associatedManagedApps":[{"href":"/orgs/123/managed-apps/345","id":"123"},{"href":"/orgs/123/managed-apps/345","id":"123"},{"href":"/orgs/123/managed-apps/345","id":"123"}],"createdAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"workday","notes":"license had a discount of 10","pointOfContactEmail":"test@metasaas.com","projectId":123,"terms":[{"createdAt":"2019-10-15T16:05:36.1000Z","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","isUnlimited":true,"itemsAllowed":1,"modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","registered":true,"sku":"Odio deserunt sint beatae facilis.","termPayments":[{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6}],"termType":"perLogin"},{"createdAt":"2019-10-15T16:05:36.1000Z","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","isUnlimited":true,"itemsAllowed":1,"modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","registered":true,"sku":"Odio deserunt sint beatae facilis.","termPayments":[{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6}],"termType":"perLogin"},{"createdAt":"2019-10-15T16:05:36.1000Z","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","isUnlimited":true,"itemsAllowed":1,"modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","registered":true,"sku":"Odio deserunt sint beatae facilis.","termPayments":[{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6}],"termType":"perLogin"}]},{"agreementFees":[{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Quarterly","paymentFrequencyInMonths":6},{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Quarterly","paymentFrequencyInMonths":6},{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Quarterly","paymentFrequencyInMonths":6},{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Quarterly","paymentFrequencyInMonths":6}],"associatedManagedApps":[{"href":"/orgs/123/managed-apps/345","id":"123"},{"href":"/orgs/123/managed-apps/345","id":"123"},{"href":"/orgs/123/managed-apps/345","id":"123"}],"createdAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"workday","notes":"license had a discount of 10","pointOfContactEmail":"test@metasaas.com","projectId":123,"terms":[{"createdAt":"2019-10-15T16:05:36.1000Z","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","isUnlimited":true,"itemsAllowed":1,"modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","registered":true,"sku":"Odio deserunt sint beatae facilis.","termPayments":[{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6}],"termType":"perLogin"},{"createdAt":"2019-10-15T16:05:36.1000Z","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","isUnlimited":true,"itemsAllowed":1,"modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","registered":true,"sku":"Odio deserunt sint beatae facilis.","termPayments":[{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6}],"termType":"perLogin"},{"createdAt":"2019-10-15T16:05:36.1000Z","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","isUnlimited":true,"itemsAllowed":1,"modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","registered":true,"sku":"Odio deserunt sint beatae facilis.","termPayments":[{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6}],"termType":"perLogin"}]},{"agreementFees":[{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Quarterly","paymentFrequencyInMonths":6},{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Quarterly","paymentFrequencyInMonths":6},{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Quarterly","paymentFrequencyInMonths":6},{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Quarterly","paymentFrequencyInMonths":6}],"associatedManagedApps":[{"href":"/orgs/123/managed-apps/345","id":"123"},{"href":"/orgs/123/managed-apps/345","id":"123"},{"href":"/orgs/123/managed-apps/345","id":"123"}],"createdAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"workday","notes":"license had a discount of 10","pointOfContactEmail":"test@metasaas.com","projectId":123,"terms":[{"createdAt":"2019-10-15T16:05:36.1000Z","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","isUnlimited":true,"itemsAllowed":1,"modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","registered":true,"sku":"Odio deserunt sint beatae facilis.","termPayments":[{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6}],"termType":"perLogin"},{"createdAt":"2019-10-15T16:05:36.1000Z","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","isUnlimited":true,"itemsAllowed":1,"modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","registered":true,"sku":"Odio deserunt sint beatae facilis.","termPayments":[{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6}],"termType":"perLogin"},{"createdAt":"2019-10-15T16:05:36.1000Z","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","isUnlimited":true,"itemsAllowed":1,"modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","registered":true,"sku":"Odio deserunt sint beatae facilis.","termPayments":[{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Triannually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Monthly","paymentFrequencyInMonths":6}],"termType":"perLogin"}]}]}

Status: 400 - Bad Request response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Show

Show license.

Retrieves a license identified by ID.


/saas/v1/orgs/{orgId}/licenses/{licenseId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/licenses/{licenseId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LicensesApi;

import java.io.File;
import java.util.*;

public class LicensesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        LicensesApi apiInstance = new LicensesApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String licenseId = licenseId_example; // String | identifies an license by given license ID.
        try {
            FlexeraFsmDenormalizedlicenseagreement result = apiInstance.licensesShow(orgId, licenseId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LicensesApi#licensesShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LicensesApi;

public class LicensesApiExample {

    public static void main(String[] args) {
        LicensesApi apiInstance = new LicensesApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String licenseId = licenseId_example; // String | identifies an license by given license ID.
        try {
            FlexeraFsmDenormalizedlicenseagreement result = apiInstance.licensesShow(orgId, licenseId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LicensesApi#licensesShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given ID.
String *licenseId = licenseId_example; // identifies an license by given license ID.

LicensesApi *apiInstance = [[LicensesApi alloc] init];

// Show license.
[apiInstance licensesShowWith:orgId
    licenseId:licenseId
              completionHandler: ^(FlexeraFsmDenormalizedlicenseagreement output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.LicensesApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.
var licenseId = licenseId_example; // {{String}} identifies an license by given license ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.licensesShow(orgId, licenseId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class licensesShowExample
    {
        public void main()
        {


            var apiInstance = new LicensesApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.
            var licenseId = licenseId_example;  // String | identifies an license by given license ID.

            try
            {
                // Show license.
                FlexeraFsmDenormalizedlicenseagreement result = apiInstance.licensesShow(orgId, licenseId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LicensesApi.licensesShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiLicensesApi();
$orgId = orgId_example; // String | orgId identifies an organization by given ID.
$licenseId = licenseId_example; // String | identifies an license by given license ID.

try {
    $result = $api_instance->licensesShow($orgId, $licenseId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LicensesApi->licensesShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LicensesApi;


my $api_instance = WWW::SwaggerClient::LicensesApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.
my $licenseId = licenseId_example; # String | identifies an license by given license ID.

eval { 
    my $result = $api_instance->licensesShow(orgId => $orgId, licenseId => $licenseId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LicensesApi->licensesShow: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.LicensesApi()
orgId = orgId_example # String | orgId identifies an organization by given ID.
licenseId = licenseId_example # String | identifies an license by given license ID.

try: 
    # Show license.
    api_response = api_instance.licenses_show(orgId, licenseId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LicensesApi->licensesShow: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required
licenseId*
String
identifies an license by given license ID.
Required

Responses

Status: 200 - OK response.

{"agreementFees":[{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Once","paymentFrequencyInMonths":6},{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Once","paymentFrequencyInMonths":6},{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Once","paymentFrequencyInMonths":6},{"amount":"1000","createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2018-12-30T00:00:00.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","paymentFrequency":"Once","paymentFrequencyInMonths":6}],"associatedManagedApps":[{"href":"/orgs/123/managed-apps/345","id":"123"},{"href":"/orgs/123/managed-apps/345","id":"123"},{"href":"/orgs/123/managed-apps/345","id":"123"}],"createdAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","name":"workday","notes":"license had a discount of 10","pointOfContactEmail":"test@metasaas.com","projectId":123,"terms":[{"createdAt":"2019-10-15T16:05:36.1000Z","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","isUnlimited":true,"itemsAllowed":1,"modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","registered":true,"sku":"Est dignissimos aut ipsa.","termPayments":[{"amount":"1000","blockEnd":500,"blockFrequency":"Annually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Every 18 Months","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Annually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Every 18 Months","paymentFrequencyInMonths":6}],"termType":"perLogin"},{"createdAt":"2019-10-15T16:05:36.1000Z","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","isUnlimited":true,"itemsAllowed":1,"modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","registered":true,"sku":"Est dignissimos aut ipsa.","termPayments":[{"amount":"1000","blockEnd":500,"blockFrequency":"Annually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Every 18 Months","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Annually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Every 18 Months","paymentFrequencyInMonths":6}],"termType":"perLogin"},{"createdAt":"2019-10-15T16:05:36.1000Z","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","isUnlimited":true,"itemsAllowed":1,"modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","registered":true,"sku":"Est dignissimos aut ipsa.","termPayments":[{"amount":"1000","blockEnd":500,"blockFrequency":"Annually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Every 18 Months","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Annually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Every 18 Months","paymentFrequencyInMonths":6}],"termType":"perLogin"},{"createdAt":"2019-10-15T16:05:36.1000Z","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","isUnlimited":true,"itemsAllowed":1,"modifiedAt":"2019-10-15T16:05:36.1000Z","name":"Workday","registered":true,"sku":"Est dignissimos aut ipsa.","termPayments":[{"amount":"1000","blockEnd":500,"blockFrequency":"Annually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Every 18 Months","paymentFrequencyInMonths":6},{"amount":"1000","blockEnd":500,"blockFrequency":"Annually","blockFrequencyInMonths":6,"blockStart":100,"createdAt":"2019-10-15T16:05:36.1000Z","currency":"USD","effectiveAt":"2019-10-15T16:05:36.1000Z","endsAt":"2019-10-15T16:05:36.1000Z","id":"123","modifiedAt":"2019-10-15T16:05:36.1000Z","paymentFrequency":"Every 18 Months","paymentFrequencyInMonths":6}],"termType":"perLogin"}]}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Managed Application Events

Index

List managed application events.

Retrieves a collection of managed application events.


/saas/v1/orgs/{orgId}/app-events

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/app-events?filter=&orderBy=&skipToken=&paginationLimit=&mostRecentEventsOnly="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagedApplicationEventsApi;

import java.io.File;
import java.util.*;

public class ManagedApplicationEventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ManagedApplicationEventsApi apiInstance = new ManagedApplicationEventsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | The date filter to query the managed application events. Supported fields in the filter are [occurredAt]
        String orderBy = orderBy_example; // String | The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored.
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        Boolean mostRecentEventsOnly = true; // Boolean | If true, returns recent events per uniqueId and subAppName
        try {
            ManagedApplicationEvents result = apiInstance.managed_Application_EventsIndex(orgId, filter, orderBy, skipToken, paginationLimit, mostRecentEventsOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationEventsApi#managed_Application_EventsIndex");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagedApplicationEventsApi;

public class ManagedApplicationEventsApiExample {

    public static void main(String[] args) {
        ManagedApplicationEventsApi apiInstance = new ManagedApplicationEventsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | The date filter to query the managed application events. Supported fields in the filter are [occurredAt]
        String orderBy = orderBy_example; // String | The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored.
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        Boolean mostRecentEventsOnly = true; // Boolean | If true, returns recent events per uniqueId and subAppName
        try {
            ManagedApplicationEvents result = apiInstance.managed_Application_EventsIndex(orgId, filter, orderBy, skipToken, paginationLimit, mostRecentEventsOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationEventsApi#managed_Application_EventsIndex");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given Id.
String *filter = filter_example; // The date filter to query the managed application events. Supported fields in the filter are [occurredAt] (optional)
String *orderBy = orderBy_example; // The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored. (optional) (default to occurredAt desc)
String *skipToken = skipToken_example; // Used in pagination to point to the next set of records. (optional)
String *paginationLimit = paginationLimit_example; // Custom pagination limit to be used. (optional)
Boolean *mostRecentEventsOnly = true; // If true, returns recent events per uniqueId and subAppName (optional)

ManagedApplicationEventsApi *apiInstance = [[ManagedApplicationEventsApi alloc] init];

// List managed application events.
[apiInstance managed_Application_EventsIndexWith:orgId
    filter:filter
    orderBy:orderBy
    skipToken:skipToken
    paginationLimit:paginationLimit
    mostRecentEventsOnly:mostRecentEventsOnly
              completionHandler: ^(ManagedApplicationEvents output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ManagedApplicationEventsApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given Id.
var opts = { 
  'filter': filter_example, // {{String}} The date filter to query the managed application events. Supported fields in the filter are [occurredAt]
  'orderBy': orderBy_example, // {{String}} The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored.
  'skipToken': skipToken_example, // {{String}} Used in pagination to point to the next set of records.
  'paginationLimit': paginationLimit_example, // {{String}} Custom pagination limit to be used.
  'mostRecentEventsOnly': true // {{Boolean}} If true, returns recent events per uniqueId and subAppName
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.managed_Application_EventsIndex(orgId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class managed_Application_EventsIndexExample
    {
        public void main()
        {


            var apiInstance = new ManagedApplicationEventsApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given Id.
            var filter = filter_example;  // String | The date filter to query the managed application events. Supported fields in the filter are [occurredAt] (optional) 
            var orderBy = orderBy_example;  // String | The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored. (optional)  (default to occurredAt desc)
            var skipToken = skipToken_example;  // String | Used in pagination to point to the next set of records. (optional) 
            var paginationLimit = paginationLimit_example;  // String | Custom pagination limit to be used. (optional) 
            var mostRecentEventsOnly = true;  // Boolean | If true, returns recent events per uniqueId and subAppName (optional) 

            try
            {
                // List managed application events.
                ManagedApplicationEvents result = apiInstance.managed_Application_EventsIndex(orgId, filter, orderBy, skipToken, paginationLimit, mostRecentEventsOnly);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagedApplicationEventsApi.managed_Application_EventsIndex: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiManagedApplicationEventsApi();
$orgId = orgId_example; // String | orgId identifies an organization by given Id.
$filter = filter_example; // String | The date filter to query the managed application events. Supported fields in the filter are [occurredAt]
$orderBy = orderBy_example; // String | The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored.
$skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
$paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
$mostRecentEventsOnly = true; // Boolean | If true, returns recent events per uniqueId and subAppName

try {
    $result = $api_instance->managed_Application_EventsIndex($orgId, $filter, $orderBy, $skipToken, $paginationLimit, $mostRecentEventsOnly);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagedApplicationEventsApi->managed_Application_EventsIndex: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagedApplicationEventsApi;


my $api_instance = WWW::SwaggerClient::ManagedApplicationEventsApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given Id.
my $filter = filter_example; # String | The date filter to query the managed application events. Supported fields in the filter are [occurredAt]
my $orderBy = orderBy_example; # String | The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored.
my $skipToken = skipToken_example; # String | Used in pagination to point to the next set of records.
my $paginationLimit = paginationLimit_example; # String | Custom pagination limit to be used.
my $mostRecentEventsOnly = true; # Boolean | If true, returns recent events per uniqueId and subAppName

eval { 
    my $result = $api_instance->managed_Application_EventsIndex(orgId => $orgId, filter => $filter, orderBy => $orderBy, skipToken => $skipToken, paginationLimit => $paginationLimit, mostRecentEventsOnly => $mostRecentEventsOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagedApplicationEventsApi->managed_Application_EventsIndex: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ManagedApplicationEventsApi()
orgId = orgId_example # String | orgId identifies an organization by given Id.
filter = filter_example # String | The date filter to query the managed application events. Supported fields in the filter are [occurredAt] (optional)
orderBy = orderBy_example # String | The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored. (optional) (default to occurredAt desc)
skipToken = skipToken_example # String | Used in pagination to point to the next set of records. (optional)
paginationLimit = paginationLimit_example # String | Custom pagination limit to be used. (optional)
mostRecentEventsOnly = true # Boolean | If true, returns recent events per uniqueId and subAppName (optional)

try: 
    # List managed application events.
    api_response = api_instance.managed_application_events_index(orgId, filter=filter, orderBy=orderBy, skipToken=skipToken, paginationLimit=paginationLimit, mostRecentEventsOnly=mostRecentEventsOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagedApplicationEventsApi->managed_Application_EventsIndex: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given Id.
Required
Query parameters
Name Description
filter
String
The date filter to query the managed application events. Supported fields in the filter are [occurredAt]
orderBy
String
The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored.
skipToken
String
Used in pagination to point to the next set of records.
paginationLimit
String
Custom pagination limit to be used.
mostRecentEventsOnly
Boolean
If true, returns recent events per uniqueId and subAppName

Responses

Status: 200 - OK response.

{"nextPage":"/orgs/1/app-events?skipToken=b2NjdXJyZWQgZ3QgJzE5NzAtMDEtMDFUMDA6MDA6MDBaJyNvY2N1cnJlZCBkZXNjIzEjNTU2NDg5MDgz","values":[{"associatedManagedApp":{"href":"/orgs/123/managed-apps/345","id":"123"},"description":"Product Access","id":"123","occurredAt":"2018-05-16T16:31:52.1000Z","subAppName":"O365 Exchange","type":"Product Access","uniqueId":"123"},{"associatedManagedApp":{"href":"/orgs/123/managed-apps/345","id":"123"},"description":"Product Access","id":"123","occurredAt":"2018-05-16T16:31:52.1000Z","subAppName":"O365 Exchange","type":"Product Access","uniqueId":"123"},{"associatedManagedApp":{"href":"/orgs/123/managed-apps/345","id":"123"},"description":"Product Access","id":"123","occurredAt":"2018-05-16T16:31:52.1000Z","subAppName":"O365 Exchange","type":"Product Access","uniqueId":"123"},{"associatedManagedApp":{"href":"/orgs/123/managed-apps/345","id":"123"},"description":"Product Access","id":"123","occurredAt":"2018-05-16T16:31:52.1000Z","subAppName":"O365 Exchange","type":"Product Access","uniqueId":"123"}]}

Status: 400 - Bad Request response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Show

Show managed application event.

Retrieves a managed application event identified by ID


/saas/v1/orgs/{orgId}/app-events/{eventId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/app-events/{eventId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagedApplicationEventsApi;

import java.io.File;
import java.util.*;

public class ManagedApplicationEventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ManagedApplicationEventsApi apiInstance = new ManagedApplicationEventsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String eventId = eventId_example; // String | eventId identifies a managed application event by given ID.
        try {
            FlexeraFsmManagedapplicationevent result = apiInstance.managed_Application_EventsShow(orgId, eventId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationEventsApi#managed_Application_EventsShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagedApplicationEventsApi;

public class ManagedApplicationEventsApiExample {

    public static void main(String[] args) {
        ManagedApplicationEventsApi apiInstance = new ManagedApplicationEventsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String eventId = eventId_example; // String | eventId identifies a managed application event by given ID.
        try {
            FlexeraFsmManagedapplicationevent result = apiInstance.managed_Application_EventsShow(orgId, eventId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationEventsApi#managed_Application_EventsShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given ID.
String *eventId = eventId_example; // eventId identifies a managed application event by given ID.

ManagedApplicationEventsApi *apiInstance = [[ManagedApplicationEventsApi alloc] init];

// Show managed application event.
[apiInstance managed_Application_EventsShowWith:orgId
    eventId:eventId
              completionHandler: ^(FlexeraFsmManagedapplicationevent output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ManagedApplicationEventsApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.
var eventId = eventId_example; // {{String}} eventId identifies a managed application event by given ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.managed_Application_EventsShow(orgId, eventId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class managed_Application_EventsShowExample
    {
        public void main()
        {


            var apiInstance = new ManagedApplicationEventsApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.
            var eventId = eventId_example;  // String | eventId identifies a managed application event by given ID.

            try
            {
                // Show managed application event.
                FlexeraFsmManagedapplicationevent result = apiInstance.managed_Application_EventsShow(orgId, eventId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagedApplicationEventsApi.managed_Application_EventsShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiManagedApplicationEventsApi();
$orgId = orgId_example; // String | orgId identifies an organization by given ID.
$eventId = eventId_example; // String | eventId identifies a managed application event by given ID.

try {
    $result = $api_instance->managed_Application_EventsShow($orgId, $eventId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagedApplicationEventsApi->managed_Application_EventsShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagedApplicationEventsApi;


my $api_instance = WWW::SwaggerClient::ManagedApplicationEventsApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.
my $eventId = eventId_example; # String | eventId identifies a managed application event by given ID.

eval { 
    my $result = $api_instance->managed_Application_EventsShow(orgId => $orgId, eventId => $eventId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagedApplicationEventsApi->managed_Application_EventsShow: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ManagedApplicationEventsApi()
orgId = orgId_example # String | orgId identifies an organization by given ID.
eventId = eventId_example # String | eventId identifies a managed application event by given ID.

try: 
    # Show managed application event.
    api_response = api_instance.managed_application_events_show(orgId, eventId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagedApplicationEventsApi->managed_Application_EventsShow: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required
eventId*
String
eventId identifies a managed application event by given ID.
Required

Responses

Status: 200 - OK response.

{"associatedManagedApp":{"href":"/orgs/123/managed-apps/345","id":"123"},"description":"Product Access","id":"123","occurredAt":"2018-05-16T16:31:52.1000Z","subAppName":"O365 Exchange","type":"Product Access","uniqueId":"123"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Managed Application Users

Index

List managed application users.

Retrieves a collection of managed application users.


/saas/v1/orgs/{orgId}/app-users

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/app-users?filter=&orderBy=&skipToken=&paginationLimit=&view=&includeAll="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagedApplicationUsersApi;

import java.io.File;
import java.util.*;

public class ManagedApplicationUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ManagedApplicationUsersApi apiInstance = new ManagedApplicationUsersApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt]
        String orderBy = orderBy_example; // String | The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt].
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        String view = view_example; // String | View used to render integration template
        Boolean includeAll = true; // Boolean | Flag to determine whether or not inactive users should be included in the results
        try {
            ManagedApplicationUsers result = apiInstance.managed_Application_UsersIndex(orgId, filter, orderBy, skipToken, paginationLimit, view, includeAll);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationUsersApi#managed_Application_UsersIndex");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagedApplicationUsersApi;

public class ManagedApplicationUsersApiExample {

    public static void main(String[] args) {
        ManagedApplicationUsersApi apiInstance = new ManagedApplicationUsersApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt]
        String orderBy = orderBy_example; // String | The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt].
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        String view = view_example; // String | View used to render integration template
        Boolean includeAll = true; // Boolean | Flag to determine whether or not inactive users should be included in the results
        try {
            ManagedApplicationUsers result = apiInstance.managed_Application_UsersIndex(orgId, filter, orderBy, skipToken, paginationLimit, view, includeAll);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationUsersApi#managed_Application_UsersIndex");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given Id.
String *filter = filter_example; // The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt] (optional)
String *orderBy = orderBy_example; // The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt]. (optional) (default to lastActivityAt desc)
String *skipToken = skipToken_example; // Used in pagination to point to the next set of records. (optional)
String *paginationLimit = paginationLimit_example; // Custom pagination limit to be used. (optional)
String *view = view_example; // View used to render integration template (optional)
Boolean *includeAll = true; // Flag to determine whether or not inactive users should be included in the results (optional) (default to false)

ManagedApplicationUsersApi *apiInstance = [[ManagedApplicationUsersApi alloc] init];

// List managed application users.
[apiInstance managed_Application_UsersIndexWith:orgId
    filter:filter
    orderBy:orderBy
    skipToken:skipToken
    paginationLimit:paginationLimit
    view:view
    includeAll:includeAll
              completionHandler: ^(ManagedApplicationUsers output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ManagedApplicationUsersApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given Id.
var opts = { 
  'filter': filter_example, // {{String}} The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt]
  'orderBy': orderBy_example, // {{String}} The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt].
  'skipToken': skipToken_example, // {{String}} Used in pagination to point to the next set of records.
  'paginationLimit': paginationLimit_example, // {{String}} Custom pagination limit to be used.
  'view': view_example, // {{String}} View used to render integration template
  'includeAll': true // {{Boolean}} Flag to determine whether or not inactive users should be included in the results
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.managed_Application_UsersIndex(orgId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class managed_Application_UsersIndexExample
    {
        public void main()
        {


            var apiInstance = new ManagedApplicationUsersApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given Id.
            var filter = filter_example;  // String | The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt] (optional) 
            var orderBy = orderBy_example;  // String | The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt]. (optional)  (default to lastActivityAt desc)
            var skipToken = skipToken_example;  // String | Used in pagination to point to the next set of records. (optional) 
            var paginationLimit = paginationLimit_example;  // String | Custom pagination limit to be used. (optional) 
            var view = view_example;  // String | View used to render integration template (optional) 
            var includeAll = true;  // Boolean | Flag to determine whether or not inactive users should be included in the results (optional)  (default to false)

            try
            {
                // List managed application users.
                ManagedApplicationUsers result = apiInstance.managed_Application_UsersIndex(orgId, filter, orderBy, skipToken, paginationLimit, view, includeAll);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagedApplicationUsersApi.managed_Application_UsersIndex: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiManagedApplicationUsersApi();
$orgId = orgId_example; // String | orgId identifies an organization by given Id.
$filter = filter_example; // String | The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt]
$orderBy = orderBy_example; // String | The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt].
$skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
$paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
$view = view_example; // String | View used to render integration template
$includeAll = true; // Boolean | Flag to determine whether or not inactive users should be included in the results

try {
    $result = $api_instance->managed_Application_UsersIndex($orgId, $filter, $orderBy, $skipToken, $paginationLimit, $view, $includeAll);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagedApplicationUsersApi->managed_Application_UsersIndex: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagedApplicationUsersApi;


my $api_instance = WWW::SwaggerClient::ManagedApplicationUsersApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given Id.
my $filter = filter_example; # String | The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt]
my $orderBy = orderBy_example; # String | The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt].
my $skipToken = skipToken_example; # String | Used in pagination to point to the next set of records.
my $paginationLimit = paginationLimit_example; # String | Custom pagination limit to be used.
my $view = view_example; # String | View used to render integration template
my $includeAll = true; # Boolean | Flag to determine whether or not inactive users should be included in the results

eval { 
    my $result = $api_instance->managed_Application_UsersIndex(orgId => $orgId, filter => $filter, orderBy => $orderBy, skipToken => $skipToken, paginationLimit => $paginationLimit, view => $view, includeAll => $includeAll);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagedApplicationUsersApi->managed_Application_UsersIndex: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ManagedApplicationUsersApi()
orgId = orgId_example # String | orgId identifies an organization by given Id.
filter = filter_example # String | The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt] (optional)
orderBy = orderBy_example # String | The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt]. (optional) (default to lastActivityAt desc)
skipToken = skipToken_example # String | Used in pagination to point to the next set of records. (optional)
paginationLimit = paginationLimit_example # String | Custom pagination limit to be used. (optional)
view = view_example # String | View used to render integration template (optional)
includeAll = true # Boolean | Flag to determine whether or not inactive users should be included in the results (optional) (default to false)

try: 
    # List managed application users.
    api_response = api_instance.managed_application_users_index(orgId, filter=filter, orderBy=orderBy, skipToken=skipToken, paginationLimit=paginationLimit, view=view, includeAll=includeAll)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagedApplicationUsersApi->managed_Application_UsersIndex: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given Id.
Required
Query parameters
Name Description
filter
String
The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt]
orderBy
String
The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt].
skipToken
String
Used in pagination to point to the next set of records.
paginationLimit
String
Custom pagination limit to be used.
view
String
View used to render integration template
includeAll
Boolean
Flag to determine whether or not inactive users should be included in the results

Responses

Status: 200 - OK response.

{"nextPage":"/orgs/1/app-users?skipToken=b2NjdXJyZWQgZ3QgJzE5NzAtMDEtMDFUMDA6MDA6MDBaJyNvY2N1cnJlZCBkZXNjIzEjNTU2NDg5MDgz","values":[{"activatedAt":"2018-05-16T16:31:52.1000Z","associatedManagedApp":{"href":"/orgs/123/managed-apps/345","id":"123"},"associatedPerson":{"href":"/ods/v0/orgs/123/people/345","id":"123"},"deactivatedAt":"2018-05-16T16:31:52.1000Z","email":"test@metasaas.com","firstName":"John","id":"123","lastActivityAt":"2018-05-16T16:31:52.1000Z","lastName":"Collins","middleName":"James","modifiedAt":"2018-05-16T16:31:52.1000Z","sku":"ENTERPRISEPREMIUM","skus":["Quam veritatis ratione est autem id dolor.","Quia ea sapiente nulla tenetur qui.","Et et."],"uniqueId":"123"},{"activatedAt":"2018-05-16T16:31:52.1000Z","associatedManagedApp":{"href":"/orgs/123/managed-apps/345","id":"123"},"associatedPerson":{"href":"/ods/v0/orgs/123/people/345","id":"123"},"deactivatedAt":"2018-05-16T16:31:52.1000Z","email":"test@metasaas.com","firstName":"John","id":"123","lastActivityAt":"2018-05-16T16:31:52.1000Z","lastName":"Collins","middleName":"James","modifiedAt":"2018-05-16T16:31:52.1000Z","sku":"ENTERPRISEPREMIUM","skus":["Quam veritatis ratione est autem id dolor.","Quia ea sapiente nulla tenetur qui.","Et et."],"uniqueId":"123"}]}

Status: 400 - Bad Request response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

IndexHistory

List user's history.

Retrieves a managed application user's history identified by user ID.


/saas/v1/orgs/{orgId}/app-users/{userId}/history

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/app-users/{userId}/history"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagedApplicationUsersApi;

import java.io.File;
import java.util.*;

public class ManagedApplicationUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ManagedApplicationUsersApi apiInstance = new ManagedApplicationUsersApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String userId = userId_example; // String | userId identifies an user by given Id.
        try {
            MangedApplicationUserHistories result = apiInstance.managed_Application_UsersIndexHistory(orgId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationUsersApi#managed_Application_UsersIndexHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagedApplicationUsersApi;

public class ManagedApplicationUsersApiExample {

    public static void main(String[] args) {
        ManagedApplicationUsersApi apiInstance = new ManagedApplicationUsersApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String userId = userId_example; // String | userId identifies an user by given Id.
        try {
            MangedApplicationUserHistories result = apiInstance.managed_Application_UsersIndexHistory(orgId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationUsersApi#managed_Application_UsersIndexHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given Id.
String *userId = userId_example; // userId identifies an user by given Id.

ManagedApplicationUsersApi *apiInstance = [[ManagedApplicationUsersApi alloc] init];

// List user's history.
[apiInstance managed_Application_UsersIndexHistoryWith:orgId
    userId:userId
              completionHandler: ^(MangedApplicationUserHistories output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ManagedApplicationUsersApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given Id.
var userId = userId_example; // {{String}} userId identifies an user by given Id.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.managed_Application_UsersIndexHistory(orgId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class managed_Application_UsersIndexHistoryExample
    {
        public void main()
        {


            var apiInstance = new ManagedApplicationUsersApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given Id.
            var userId = userId_example;  // String | userId identifies an user by given Id.

            try
            {
                // List user's history.
                MangedApplicationUserHistories result = apiInstance.managed_Application_UsersIndexHistory(orgId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagedApplicationUsersApi.managed_Application_UsersIndexHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiManagedApplicationUsersApi();
$orgId = orgId_example; // String | orgId identifies an organization by given Id.
$userId = userId_example; // String | userId identifies an user by given Id.

try {
    $result = $api_instance->managed_Application_UsersIndexHistory($orgId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagedApplicationUsersApi->managed_Application_UsersIndexHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagedApplicationUsersApi;


my $api_instance = WWW::SwaggerClient::ManagedApplicationUsersApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given Id.
my $userId = userId_example; # String | userId identifies an user by given Id.

eval { 
    my $result = $api_instance->managed_Application_UsersIndexHistory(orgId => $orgId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagedApplicationUsersApi->managed_Application_UsersIndexHistory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ManagedApplicationUsersApi()
orgId = orgId_example # String | orgId identifies an organization by given Id.
userId = userId_example # String | userId identifies an user by given Id.

try: 
    # List user's history.
    api_response = api_instance.managed_application_users_index_history(orgId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagedApplicationUsersApi->managed_Application_UsersIndexHistory: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given Id.
Required
userId*
String
userId identifies an user by given Id.
Required

Responses

Status: 200 - OK response.

{"nextPage":"/orgs/1/app-users/123/history?skipToken=b2NjdXJyZWQgZ3QgJzE5NzAtMDEtMDFUMDA6MDA6MDBaJyNvY2N1cnJlZCBkZXNjIzEjNTU2NDg5MDgz","values":[{"category":"Reclamation State","changedBy":"ServiceUser","description":"Reclamation state changed from RUNNING to CANCELLED","managedAppId":"123","occurredAt":"2018-05-16T16:31:52.1000Z","orgId":"123","userId":"123"},{"category":"Reclamation State","changedBy":"ServiceUser","description":"Reclamation state changed from RUNNING to CANCELLED","managedAppId":"123","occurredAt":"2018-05-16T16:31:52.1000Z","orgId":"123","userId":"123"}]}

Status: 400 - Bad Request response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Show

Show managed application user.

Retrieves a managed application user identified by user ID.


/saas/v1/orgs/{orgId}/app-users/{userId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/app-users/{userId}?view=&includeAll="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagedApplicationUsersApi;

import java.io.File;
import java.util.*;

public class ManagedApplicationUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ManagedApplicationUsersApi apiInstance = new ManagedApplicationUsersApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String userId = userId_example; // String | userId identifies an user by given ID.
        String view = view_example; // String | View used to render integration template.
        Boolean includeAll = true; // Boolean | Flag to determine whether or not inactive users should be included in the results.
        try {
            FlexeraFsmManagedapplicationuser result = apiInstance.managed_Application_UsersShow(orgId, userId, view, includeAll);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationUsersApi#managed_Application_UsersShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagedApplicationUsersApi;

public class ManagedApplicationUsersApiExample {

    public static void main(String[] args) {
        ManagedApplicationUsersApi apiInstance = new ManagedApplicationUsersApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String userId = userId_example; // String | userId identifies an user by given ID.
        String view = view_example; // String | View used to render integration template.
        Boolean includeAll = true; // Boolean | Flag to determine whether or not inactive users should be included in the results.
        try {
            FlexeraFsmManagedapplicationuser result = apiInstance.managed_Application_UsersShow(orgId, userId, view, includeAll);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationUsersApi#managed_Application_UsersShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given ID.
String *userId = userId_example; // userId identifies an user by given ID.
String *view = view_example; // View used to render integration template. (optional)
Boolean *includeAll = true; // Flag to determine whether or not inactive users should be included in the results. (optional) (default to false)

ManagedApplicationUsersApi *apiInstance = [[ManagedApplicationUsersApi alloc] init];

// Show managed application user.
[apiInstance managed_Application_UsersShowWith:orgId
    userId:userId
    view:view
    includeAll:includeAll
              completionHandler: ^(FlexeraFsmManagedapplicationuser output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ManagedApplicationUsersApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.
var userId = userId_example; // {{String}} userId identifies an user by given ID.
var opts = { 
  'view': view_example, // {{String}} View used to render integration template.
  'includeAll': true // {{Boolean}} Flag to determine whether or not inactive users should be included in the results.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.managed_Application_UsersShow(orgId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class managed_Application_UsersShowExample
    {
        public void main()
        {


            var apiInstance = new ManagedApplicationUsersApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.
            var userId = userId_example;  // String | userId identifies an user by given ID.
            var view = view_example;  // String | View used to render integration template. (optional) 
            var includeAll = true;  // Boolean | Flag to determine whether or not inactive users should be included in the results. (optional)  (default to false)

            try
            {
                // Show managed application user.
                FlexeraFsmManagedapplicationuser result = apiInstance.managed_Application_UsersShow(orgId, userId, view, includeAll);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagedApplicationUsersApi.managed_Application_UsersShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiManagedApplicationUsersApi();
$orgId = orgId_example; // String | orgId identifies an organization by given ID.
$userId = userId_example; // String | userId identifies an user by given ID.
$view = view_example; // String | View used to render integration template.
$includeAll = true; // Boolean | Flag to determine whether or not inactive users should be included in the results.

try {
    $result = $api_instance->managed_Application_UsersShow($orgId, $userId, $view, $includeAll);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagedApplicationUsersApi->managed_Application_UsersShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagedApplicationUsersApi;


my $api_instance = WWW::SwaggerClient::ManagedApplicationUsersApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.
my $userId = userId_example; # String | userId identifies an user by given ID.
my $view = view_example; # String | View used to render integration template.
my $includeAll = true; # Boolean | Flag to determine whether or not inactive users should be included in the results.

eval { 
    my $result = $api_instance->managed_Application_UsersShow(orgId => $orgId, userId => $userId, view => $view, includeAll => $includeAll);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagedApplicationUsersApi->managed_Application_UsersShow: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ManagedApplicationUsersApi()
orgId = orgId_example # String | orgId identifies an organization by given ID.
userId = userId_example # String | userId identifies an user by given ID.
view = view_example # String | View used to render integration template. (optional)
includeAll = true # Boolean | Flag to determine whether or not inactive users should be included in the results. (optional) (default to false)

try: 
    # Show managed application user.
    api_response = api_instance.managed_application_users_show(orgId, userId, view=view, includeAll=includeAll)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagedApplicationUsersApi->managed_Application_UsersShow: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required
userId*
String
userId identifies an user by given ID.
Required
Query parameters
Name Description
view
String
View used to render integration template.
includeAll
Boolean
Flag to determine whether or not inactive users should be included in the results.

Responses

Status: 200 - OK response.

{"activatedAt":"2018-05-16T16:31:52.1000Z","associatedManagedApp":{"href":"/orgs/123/managed-apps/345","id":"123"},"associatedPerson":{"href":"/ods/v0/orgs/123/people/345","id":"123"},"deactivatedAt":"2018-05-16T16:31:52.1000Z","email":"test@metasaas.com","firstName":"John","id":"123","lastActivityAt":"2018-05-16T16:31:52.1000Z","lastName":"Collins","middleName":"James","modifiedAt":"2018-05-16T16:31:52.1000Z","sku":"ENTERPRISEPREMIUM","skus":["Numquam natus nihil cumque libero.","Blanditiis sed labore qui sequi et aliquam.","Dolorem aut deserunt minus quia sunt aspernatur.","Tenetur saepe."],"uniqueId":"123"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Managed Applications

Create

Create managed application.

This endpoint allows the creation of a managed application.


/saas/v1/orgs/{orgId}/managed-apps

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/vnd.goa.error"\
-H "Content-Type: application/json"\
"http://localhost:80/saas/v1/orgs/{orgId}/managed-apps"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagedApplicationsApi;

import java.io.File;
import java.util.*;

public class ManagedApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ManagedApplicationsApi apiInstance = new ManagedApplicationsApi();
        CreateRequestBody body = {
  "activityThreshold" : 1,
  "appId" : "123",
  "description" : "Office 365",
  "managedStatus" : "managed",
  "name" : "Office 365",
  "pointOfContact" : "test@metasaas.com"
}; // CreateRequestBody | 
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        try {
            apiInstance.managed_ApplicationsCreate(body, orgId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationsApi#managed_ApplicationsCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagedApplicationsApi;

public class ManagedApplicationsApiExample {

    public static void main(String[] args) {
        ManagedApplicationsApi apiInstance = new ManagedApplicationsApi();
        CreateRequestBody body = {
  "activityThreshold" : 1,
  "appId" : "123",
  "description" : "Office 365",
  "managedStatus" : "managed",
  "name" : "Office 365",
  "pointOfContact" : "test@metasaas.com"
}; // CreateRequestBody | 
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        try {
            apiInstance.managed_ApplicationsCreate(body, orgId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationsApi#managed_ApplicationsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
CreateRequestBody *body = {
  "activityThreshold" : 1,
  "appId" : "123",
  "description" : "Office 365",
  "managedStatus" : "managed",
  "name" : "Office 365",
  "pointOfContact" : "test@metasaas.com"
}; // 
String *orgId = orgId_example; // orgId identifies an organization by given ID.

ManagedApplicationsApi *apiInstance = [[ManagedApplicationsApi alloc] init];

// Create managed application.
[apiInstance managed_ApplicationsCreateWith:body
    orgId:orgId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ManagedApplicationsApi()
var body = {
  "activityThreshold" : 1,
  "appId" : "123",
  "description" : "Office 365",
  "managedStatus" : "managed",
  "name" : "Office 365",
  "pointOfContact" : "test@metasaas.com"
}; // {{CreateRequestBody}} 
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.managed_ApplicationsCreate(bodyorgId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class managed_ApplicationsCreateExample
    {
        public void main()
        {


            var apiInstance = new ManagedApplicationsApi();
            var body = new CreateRequestBody(); // CreateRequestBody | 
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.

            try
            {
                // Create managed application.
                apiInstance.managed_ApplicationsCreate(body, orgId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagedApplicationsApi.managed_ApplicationsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiManagedApplicationsApi();
$body = {
  "activityThreshold" : 1,
  "appId" : "123",
  "description" : "Office 365",
  "managedStatus" : "managed",
  "name" : "Office 365",
  "pointOfContact" : "test@metasaas.com"
}; // CreateRequestBody | 
$orgId = orgId_example; // String | orgId identifies an organization by given ID.

try {
    $api_instance->managed_ApplicationsCreate($body, $orgId);
} catch (Exception $e) {
    echo 'Exception when calling ManagedApplicationsApi->managed_ApplicationsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagedApplicationsApi;


my $api_instance = WWW::SwaggerClient::ManagedApplicationsApi->new();
my $body = WWW::SwaggerClient::Object::CreateRequestBody->new(); # CreateRequestBody | 
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.

eval { 
    $api_instance->managed_ApplicationsCreate(body => $body, orgId => $orgId);
};
if ($@) {
    warn "Exception when calling ManagedApplicationsApi->managed_ApplicationsCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ManagedApplicationsApi()
body = {
  "activityThreshold" : 1,
  "appId" : "123",
  "description" : "Office 365",
  "managedStatus" : "managed",
  "name" : "Office 365",
  "pointOfContact" : "test@metasaas.com"
} # CreateRequestBody | 
orgId = orgId_example # String | orgId identifies an organization by given ID.

try: 
    # Create managed application.
    api_instance.managed_applications_create(body, orgId)
except ApiException as e:
    print("Exception when calling ManagedApplicationsApi->managed_ApplicationsCreate: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created response.

Name Type Format Description
Location String /saas/v1/orgs/123/managed-apps/456 URL for the newly created managed application

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Delete

Delete managed application.

Deletes a managed application identified by ID.


/saas/v1/orgs/{orgId}/managed-apps/{managedAppId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/managed-apps/{managedAppId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagedApplicationsApi;

import java.io.File;
import java.util.*;

public class ManagedApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ManagedApplicationsApi apiInstance = new ManagedApplicationsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String managedAppId = managedAppId_example; // String | managedAppId identifies an managed application by given ID.
        try {
            apiInstance.managed_ApplicationsDelete(orgId, managedAppId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationsApi#managed_ApplicationsDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagedApplicationsApi;

public class ManagedApplicationsApiExample {

    public static void main(String[] args) {
        ManagedApplicationsApi apiInstance = new ManagedApplicationsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String managedAppId = managedAppId_example; // String | managedAppId identifies an managed application by given ID.
        try {
            apiInstance.managed_ApplicationsDelete(orgId, managedAppId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationsApi#managed_ApplicationsDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given ID.
String *managedAppId = managedAppId_example; // managedAppId identifies an managed application by given ID.

ManagedApplicationsApi *apiInstance = [[ManagedApplicationsApi alloc] init];

// Delete managed application.
[apiInstance managed_ApplicationsDeleteWith:orgId
    managedAppId:managedAppId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ManagedApplicationsApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.
var managedAppId = managedAppId_example; // {{String}} managedAppId identifies an managed application by given ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.managed_ApplicationsDelete(orgId, managedAppId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class managed_ApplicationsDeleteExample
    {
        public void main()
        {


            var apiInstance = new ManagedApplicationsApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.
            var managedAppId = managedAppId_example;  // String | managedAppId identifies an managed application by given ID.

            try
            {
                // Delete managed application.
                apiInstance.managed_ApplicationsDelete(orgId, managedAppId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagedApplicationsApi.managed_ApplicationsDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiManagedApplicationsApi();
$orgId = orgId_example; // String | orgId identifies an organization by given ID.
$managedAppId = managedAppId_example; // String | managedAppId identifies an managed application by given ID.

try {
    $api_instance->managed_ApplicationsDelete($orgId, $managedAppId);
} catch (Exception $e) {
    echo 'Exception when calling ManagedApplicationsApi->managed_ApplicationsDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagedApplicationsApi;


my $api_instance = WWW::SwaggerClient::ManagedApplicationsApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.
my $managedAppId = managedAppId_example; # String | managedAppId identifies an managed application by given ID.

eval { 
    $api_instance->managed_ApplicationsDelete(orgId => $orgId, managedAppId => $managedAppId);
};
if ($@) {
    warn "Exception when calling ManagedApplicationsApi->managed_ApplicationsDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ManagedApplicationsApi()
orgId = orgId_example # String | orgId identifies an organization by given ID.
managedAppId = managedAppId_example # String | managedAppId identifies an managed application by given ID.

try: 
    # Delete managed application.
    api_instance.managed_applications_delete(orgId, managedAppId)
except ApiException as e:
    print("Exception when calling ManagedApplicationsApi->managed_ApplicationsDelete: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required
managedAppId*
String
managedAppId identifies an managed application by given ID.
Required

Responses

Status: 200 - OK response.

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

GetAppEventsForManagedApp

List application events for a managed application.

Retrieves a collection of application events for a specific managed application identified by 'managedAppId'.


/saas/v1/orgs/{orgId}/managed-apps/{managedAppId}/app-events

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/managed-apps/{managedAppId}/app-events?filter=&orderBy=&skipToken=&paginationLimit=&mostRecentEventsOnly="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagedApplicationsApi;

import java.io.File;
import java.util.*;

public class ManagedApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ManagedApplicationsApi apiInstance = new ManagedApplicationsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String managedAppId = managedAppId_example; // String | managedAppId identifies an managed application by given Id.
        String filter = filter_example; // String | The date filter to query the managed application events. Supported fields in the filter are [occurredAt]
        String orderBy = orderBy_example; // String | The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored.
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        Boolean mostRecentEventsOnly = true; // Boolean | If true, returns recent events per uniqueId and subAppName
        try {
            ManagedApplicationEvents result = apiInstance.managed_ApplicationsGetAppEventsForManagedApp(orgId, managedAppId, filter, orderBy, skipToken, paginationLimit, mostRecentEventsOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationsApi#managed_ApplicationsGetAppEventsForManagedApp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagedApplicationsApi;

public class ManagedApplicationsApiExample {

    public static void main(String[] args) {
        ManagedApplicationsApi apiInstance = new ManagedApplicationsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String managedAppId = managedAppId_example; // String | managedAppId identifies an managed application by given Id.
        String filter = filter_example; // String | The date filter to query the managed application events. Supported fields in the filter are [occurredAt]
        String orderBy = orderBy_example; // String | The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored.
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        Boolean mostRecentEventsOnly = true; // Boolean | If true, returns recent events per uniqueId and subAppName
        try {
            ManagedApplicationEvents result = apiInstance.managed_ApplicationsGetAppEventsForManagedApp(orgId, managedAppId, filter, orderBy, skipToken, paginationLimit, mostRecentEventsOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationsApi#managed_ApplicationsGetAppEventsForManagedApp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given Id.
String *managedAppId = managedAppId_example; // managedAppId identifies an managed application by given Id.
String *filter = filter_example; // The date filter to query the managed application events. Supported fields in the filter are [occurredAt] (optional)
String *orderBy = orderBy_example; // The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored. (optional) (default to occurredAt desc)
String *skipToken = skipToken_example; // Used in pagination to point to the next set of records. (optional)
String *paginationLimit = paginationLimit_example; // Custom pagination limit to be used. (optional)
Boolean *mostRecentEventsOnly = true; // If true, returns recent events per uniqueId and subAppName (optional)

ManagedApplicationsApi *apiInstance = [[ManagedApplicationsApi alloc] init];

// List application events for a managed application.
[apiInstance managed_ApplicationsGetAppEventsForManagedAppWith:orgId
    managedAppId:managedAppId
    filter:filter
    orderBy:orderBy
    skipToken:skipToken
    paginationLimit:paginationLimit
    mostRecentEventsOnly:mostRecentEventsOnly
              completionHandler: ^(ManagedApplicationEvents output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ManagedApplicationsApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given Id.
var managedAppId = managedAppId_example; // {{String}} managedAppId identifies an managed application by given Id.
var opts = { 
  'filter': filter_example, // {{String}} The date filter to query the managed application events. Supported fields in the filter are [occurredAt]
  'orderBy': orderBy_example, // {{String}} The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored.
  'skipToken': skipToken_example, // {{String}} Used in pagination to point to the next set of records.
  'paginationLimit': paginationLimit_example, // {{String}} Custom pagination limit to be used.
  'mostRecentEventsOnly': true // {{Boolean}} If true, returns recent events per uniqueId and subAppName
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.managed_ApplicationsGetAppEventsForManagedApp(orgId, managedAppId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class managed_ApplicationsGetAppEventsForManagedAppExample
    {
        public void main()
        {


            var apiInstance = new ManagedApplicationsApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given Id.
            var managedAppId = managedAppId_example;  // String | managedAppId identifies an managed application by given Id.
            var filter = filter_example;  // String | The date filter to query the managed application events. Supported fields in the filter are [occurredAt] (optional) 
            var orderBy = orderBy_example;  // String | The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored. (optional)  (default to occurredAt desc)
            var skipToken = skipToken_example;  // String | Used in pagination to point to the next set of records. (optional) 
            var paginationLimit = paginationLimit_example;  // String | Custom pagination limit to be used. (optional) 
            var mostRecentEventsOnly = true;  // Boolean | If true, returns recent events per uniqueId and subAppName (optional) 

            try
            {
                // List application events for a managed application.
                ManagedApplicationEvents result = apiInstance.managed_ApplicationsGetAppEventsForManagedApp(orgId, managedAppId, filter, orderBy, skipToken, paginationLimit, mostRecentEventsOnly);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagedApplicationsApi.managed_ApplicationsGetAppEventsForManagedApp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiManagedApplicationsApi();
$orgId = orgId_example; // String | orgId identifies an organization by given Id.
$managedAppId = managedAppId_example; // String | managedAppId identifies an managed application by given Id.
$filter = filter_example; // String | The date filter to query the managed application events. Supported fields in the filter are [occurredAt]
$orderBy = orderBy_example; // String | The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored.
$skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
$paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
$mostRecentEventsOnly = true; // Boolean | If true, returns recent events per uniqueId and subAppName

try {
    $result = $api_instance->managed_ApplicationsGetAppEventsForManagedApp($orgId, $managedAppId, $filter, $orderBy, $skipToken, $paginationLimit, $mostRecentEventsOnly);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagedApplicationsApi->managed_ApplicationsGetAppEventsForManagedApp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagedApplicationsApi;


my $api_instance = WWW::SwaggerClient::ManagedApplicationsApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given Id.
my $managedAppId = managedAppId_example; # String | managedAppId identifies an managed application by given Id.
my $filter = filter_example; # String | The date filter to query the managed application events. Supported fields in the filter are [occurredAt]
my $orderBy = orderBy_example; # String | The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored.
my $skipToken = skipToken_example; # String | Used in pagination to point to the next set of records.
my $paginationLimit = paginationLimit_example; # String | Custom pagination limit to be used.
my $mostRecentEventsOnly = true; # Boolean | If true, returns recent events per uniqueId and subAppName

eval { 
    my $result = $api_instance->managed_ApplicationsGetAppEventsForManagedApp(orgId => $orgId, managedAppId => $managedAppId, filter => $filter, orderBy => $orderBy, skipToken => $skipToken, paginationLimit => $paginationLimit, mostRecentEventsOnly => $mostRecentEventsOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagedApplicationsApi->managed_ApplicationsGetAppEventsForManagedApp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ManagedApplicationsApi()
orgId = orgId_example # String | orgId identifies an organization by given Id.
managedAppId = managedAppId_example # String | managedAppId identifies an managed application by given Id.
filter = filter_example # String | The date filter to query the managed application events. Supported fields in the filter are [occurredAt] (optional)
orderBy = orderBy_example # String | The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored. (optional) (default to occurredAt desc)
skipToken = skipToken_example # String | Used in pagination to point to the next set of records. (optional)
paginationLimit = paginationLimit_example # String | Custom pagination limit to be used. (optional)
mostRecentEventsOnly = true # Boolean | If true, returns recent events per uniqueId and subAppName (optional)

try: 
    # List application events for a managed application.
    api_response = api_instance.managed_applications_get_app_events_for_managed_app(orgId, managedAppId, filter=filter, orderBy=orderBy, skipToken=skipToken, paginationLimit=paginationLimit, mostRecentEventsOnly=mostRecentEventsOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagedApplicationsApi->managed_ApplicationsGetAppEventsForManagedApp: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given Id.
Required
managedAppId*
String
managedAppId identifies an managed application by given Id.
Required
Query parameters
Name Description
filter
String
The date filter to query the managed application events. Supported fields in the filter are [occurredAt]
orderBy
String
The order by filter to sort the application events. Supported fields in the orderBy are [uniqueId, subAppName, occurredAt]. If mostRecentEventsOnly is set to true then orderBy will be ignored.
skipToken
String
Used in pagination to point to the next set of records.
paginationLimit
String
Custom pagination limit to be used.
mostRecentEventsOnly
Boolean
If true, returns recent events per uniqueId and subAppName

Responses

Status: 200 - OK response.

{"nextPage":"/orgs/1/app-events?skipToken=b2NjdXJyZWQgZ3QgJzE5NzAtMDEtMDFUMDA6MDA6MDBaJyNvY2N1cnJlZCBkZXNjIzEjNTU2NDg5MDgz","values":[{"associatedManagedApp":{"href":"/orgs/123/managed-apps/345","id":"123"},"description":"Product Access","id":"123","occurredAt":"2018-05-16T16:31:52.1000Z","subAppName":"O365 Exchange","type":"Product Access","uniqueId":"123"},{"associatedManagedApp":{"href":"/orgs/123/managed-apps/345","id":"123"},"description":"Product Access","id":"123","occurredAt":"2018-05-16T16:31:52.1000Z","subAppName":"O365 Exchange","type":"Product Access","uniqueId":"123"},{"associatedManagedApp":{"href":"/orgs/123/managed-apps/345","id":"123"},"description":"Product Access","id":"123","occurredAt":"2018-05-16T16:31:52.1000Z","subAppName":"O365 Exchange","type":"Product Access","uniqueId":"123"},{"associatedManagedApp":{"href":"/orgs/123/managed-apps/345","id":"123"},"description":"Product Access","id":"123","occurredAt":"2018-05-16T16:31:52.1000Z","subAppName":"O365 Exchange","type":"Product Access","uniqueId":"123"}]}

Status: 400 - Bad Request response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

GetAppUsersForManagedApp

List application users for a managed application.

Retrieves a collection of application users for a specific managed application identified by 'managedAppId'.


/saas/v1/orgs/{orgId}/managed-apps/{managedAppId}/app-users

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/managed-apps/{managedAppId}/app-users?filter=&orderBy=&skipToken=&paginationLimit=&view=&includeAll="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagedApplicationsApi;

import java.io.File;
import java.util.*;

public class ManagedApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ManagedApplicationsApi apiInstance = new ManagedApplicationsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String managedAppId = managedAppId_example; // String | managedAppId identifies an managed application by given Id.
        String filter = filter_example; // String | The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt]
        String orderBy = orderBy_example; // String | The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        String view = view_example; // String | View used to render integration template
        Boolean includeAll = true; // Boolean | Flag to determine whether or not inactive users should be included in the results
        try {
            ManagedApplicationUsers result = apiInstance.managed_ApplicationsGetAppUsersForManagedApp(orgId, managedAppId, filter, orderBy, skipToken, paginationLimit, view, includeAll);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationsApi#managed_ApplicationsGetAppUsersForManagedApp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagedApplicationsApi;

public class ManagedApplicationsApiExample {

    public static void main(String[] args) {
        ManagedApplicationsApi apiInstance = new ManagedApplicationsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String managedAppId = managedAppId_example; // String | managedAppId identifies an managed application by given Id.
        String filter = filter_example; // String | The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt]
        String orderBy = orderBy_example; // String | The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        String view = view_example; // String | View used to render integration template
        Boolean includeAll = true; // Boolean | Flag to determine whether or not inactive users should be included in the results
        try {
            ManagedApplicationUsers result = apiInstance.managed_ApplicationsGetAppUsersForManagedApp(orgId, managedAppId, filter, orderBy, skipToken, paginationLimit, view, includeAll);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationsApi#managed_ApplicationsGetAppUsersForManagedApp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given Id.
String *managedAppId = managedAppId_example; // managedAppId identifies an managed application by given Id.
String *filter = filter_example; // The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt] (optional)
String *orderBy = orderBy_example; // The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt] (optional) (default to lastActivityAt desc)
String *skipToken = skipToken_example; // Used in pagination to point to the next set of records. (optional)
String *paginationLimit = paginationLimit_example; // Custom pagination limit to be used. (optional)
String *view = view_example; // View used to render integration template (optional)
Boolean *includeAll = true; // Flag to determine whether or not inactive users should be included in the results (optional) (default to false)

ManagedApplicationsApi *apiInstance = [[ManagedApplicationsApi alloc] init];

// List application users for a managed application.
[apiInstance managed_ApplicationsGetAppUsersForManagedAppWith:orgId
    managedAppId:managedAppId
    filter:filter
    orderBy:orderBy
    skipToken:skipToken
    paginationLimit:paginationLimit
    view:view
    includeAll:includeAll
              completionHandler: ^(ManagedApplicationUsers output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ManagedApplicationsApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given Id.
var managedAppId = managedAppId_example; // {{String}} managedAppId identifies an managed application by given Id.
var opts = { 
  'filter': filter_example, // {{String}} The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt]
  'orderBy': orderBy_example, // {{String}} The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt]
  'skipToken': skipToken_example, // {{String}} Used in pagination to point to the next set of records.
  'paginationLimit': paginationLimit_example, // {{String}} Custom pagination limit to be used.
  'view': view_example, // {{String}} View used to render integration template
  'includeAll': true // {{Boolean}} Flag to determine whether or not inactive users should be included in the results
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.managed_ApplicationsGetAppUsersForManagedApp(orgId, managedAppId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class managed_ApplicationsGetAppUsersForManagedAppExample
    {
        public void main()
        {


            var apiInstance = new ManagedApplicationsApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given Id.
            var managedAppId = managedAppId_example;  // String | managedAppId identifies an managed application by given Id.
            var filter = filter_example;  // String | The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt] (optional) 
            var orderBy = orderBy_example;  // String | The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt] (optional)  (default to lastActivityAt desc)
            var skipToken = skipToken_example;  // String | Used in pagination to point to the next set of records. (optional) 
            var paginationLimit = paginationLimit_example;  // String | Custom pagination limit to be used. (optional) 
            var view = view_example;  // String | View used to render integration template (optional) 
            var includeAll = true;  // Boolean | Flag to determine whether or not inactive users should be included in the results (optional)  (default to false)

            try
            {
                // List application users for a managed application.
                ManagedApplicationUsers result = apiInstance.managed_ApplicationsGetAppUsersForManagedApp(orgId, managedAppId, filter, orderBy, skipToken, paginationLimit, view, includeAll);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagedApplicationsApi.managed_ApplicationsGetAppUsersForManagedApp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiManagedApplicationsApi();
$orgId = orgId_example; // String | orgId identifies an organization by given Id.
$managedAppId = managedAppId_example; // String | managedAppId identifies an managed application by given Id.
$filter = filter_example; // String | The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt]
$orderBy = orderBy_example; // String | The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt]
$skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
$paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
$view = view_example; // String | View used to render integration template
$includeAll = true; // Boolean | Flag to determine whether or not inactive users should be included in the results

try {
    $result = $api_instance->managed_ApplicationsGetAppUsersForManagedApp($orgId, $managedAppId, $filter, $orderBy, $skipToken, $paginationLimit, $view, $includeAll);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagedApplicationsApi->managed_ApplicationsGetAppUsersForManagedApp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagedApplicationsApi;


my $api_instance = WWW::SwaggerClient::ManagedApplicationsApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given Id.
my $managedAppId = managedAppId_example; # String | managedAppId identifies an managed application by given Id.
my $filter = filter_example; # String | The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt]
my $orderBy = orderBy_example; # String | The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt]
my $skipToken = skipToken_example; # String | Used in pagination to point to the next set of records.
my $paginationLimit = paginationLimit_example; # String | Custom pagination limit to be used.
my $view = view_example; # String | View used to render integration template
my $includeAll = true; # Boolean | Flag to determine whether or not inactive users should be included in the results

eval { 
    my $result = $api_instance->managed_ApplicationsGetAppUsersForManagedApp(orgId => $orgId, managedAppId => $managedAppId, filter => $filter, orderBy => $orderBy, skipToken => $skipToken, paginationLimit => $paginationLimit, view => $view, includeAll => $includeAll);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagedApplicationsApi->managed_ApplicationsGetAppUsersForManagedApp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ManagedApplicationsApi()
orgId = orgId_example # String | orgId identifies an organization by given Id.
managedAppId = managedAppId_example # String | managedAppId identifies an managed application by given Id.
filter = filter_example # String | The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt] (optional)
orderBy = orderBy_example # String | The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt] (optional) (default to lastActivityAt desc)
skipToken = skipToken_example # String | Used in pagination to point to the next set of records. (optional)
paginationLimit = paginationLimit_example # String | Custom pagination limit to be used. (optional)
view = view_example # String | View used to render integration template (optional)
includeAll = true # Boolean | Flag to determine whether or not inactive users should be included in the results (optional) (default to false)

try: 
    # List application users for a managed application.
    api_response = api_instance.managed_applications_get_app_users_for_managed_app(orgId, managedAppId, filter=filter, orderBy=orderBy, skipToken=skipToken, paginationLimit=paginationLimit, view=view, includeAll=includeAll)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagedApplicationsApi->managed_ApplicationsGetAppUsersForManagedApp: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given Id.
Required
managedAppId*
String
managedAppId identifies an managed application by given Id.
Required
Query parameters
Name Description
filter
String
The date filter to query the managed application users. Supported fields in the filter are [lastActivityAt]
orderBy
String
The order by filter to sort the managed application users. Supported fields in the orderBy are [lastActivityAt]
skipToken
String
Used in pagination to point to the next set of records.
paginationLimit
String
Custom pagination limit to be used.
view
String
View used to render integration template
includeAll
Boolean
Flag to determine whether or not inactive users should be included in the results

Responses

Status: 200 - OK response.

{"nextPage":"/orgs/1/app-users?skipToken=b2NjdXJyZWQgZ3QgJzE5NzAtMDEtMDFUMDA6MDA6MDBaJyNvY2N1cnJlZCBkZXNjIzEjNTU2NDg5MDgz","values":[{"activatedAt":"2018-05-16T16:31:52.1000Z","associatedManagedApp":{"href":"/orgs/123/managed-apps/345","id":"123"},"associatedPerson":{"href":"/ods/v0/orgs/123/people/345","id":"123"},"deactivatedAt":"2018-05-16T16:31:52.1000Z","email":"test@metasaas.com","firstName":"John","id":"123","lastActivityAt":"2018-05-16T16:31:52.1000Z","lastName":"Collins","middleName":"James","modifiedAt":"2018-05-16T16:31:52.1000Z","sku":"ENTERPRISEPREMIUM","skus":["Quam veritatis ratione est autem id dolor.","Quia ea sapiente nulla tenetur qui.","Et et."],"uniqueId":"123"},{"activatedAt":"2018-05-16T16:31:52.1000Z","associatedManagedApp":{"href":"/orgs/123/managed-apps/345","id":"123"},"associatedPerson":{"href":"/ods/v0/orgs/123/people/345","id":"123"},"deactivatedAt":"2018-05-16T16:31:52.1000Z","email":"test@metasaas.com","firstName":"John","id":"123","lastActivityAt":"2018-05-16T16:31:52.1000Z","lastName":"Collins","middleName":"James","modifiedAt":"2018-05-16T16:31:52.1000Z","sku":"ENTERPRISEPREMIUM","skus":["Quam veritatis ratione est autem id dolor.","Quia ea sapiente nulla tenetur qui.","Et et."],"uniqueId":"123"}]}

Status: 400 - Bad Request response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Index

List managed applications.

Retrieves a collection of managed applications.


/saas/v1/orgs/{orgId}/managed-apps

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/managed-apps?filter=&orderBy=&skipToken=&paginationLimit=&view="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagedApplicationsApi;

import java.io.File;
import java.util.*;

public class ManagedApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ManagedApplicationsApi apiInstance = new ManagedApplicationsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | The date filter to query the managed applications. Supported fields in the filter are [modifiedAt, productId]
        String orderBy = orderBy_example; // String | The order by filter to sort the managed applications. Supported fields in the orderBy are [modifiedAt]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        String view = view_example; // String | View for managed applications.
        try {
            ManagedApplications result = apiInstance.managed_ApplicationsIndex(orgId, filter, orderBy, skipToken, paginationLimit, view);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationsApi#managed_ApplicationsIndex");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagedApplicationsApi;

public class ManagedApplicationsApiExample {

    public static void main(String[] args) {
        ManagedApplicationsApi apiInstance = new ManagedApplicationsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | The date filter to query the managed applications. Supported fields in the filter are [modifiedAt, productId]
        String orderBy = orderBy_example; // String | The order by filter to sort the managed applications. Supported fields in the orderBy are [modifiedAt]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        String view = view_example; // String | View for managed applications.
        try {
            ManagedApplications result = apiInstance.managed_ApplicationsIndex(orgId, filter, orderBy, skipToken, paginationLimit, view);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationsApi#managed_ApplicationsIndex");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given Id.
String *filter = filter_example; // The date filter to query the managed applications. Supported fields in the filter are [modifiedAt, productId] (optional)
String *orderBy = orderBy_example; // The order by filter to sort the managed applications. Supported fields in the orderBy are [modifiedAt] (optional) (default to modifiedAt desc)
String *skipToken = skipToken_example; // Used in pagination to point to the next set of records. (optional)
String *paginationLimit = paginationLimit_example; // Custom pagination limit to be used. (optional)
String *view = view_example; // View for managed applications. (optional)

ManagedApplicationsApi *apiInstance = [[ManagedApplicationsApi alloc] init];

// List managed applications.
[apiInstance managed_ApplicationsIndexWith:orgId
    filter:filter
    orderBy:orderBy
    skipToken:skipToken
    paginationLimit:paginationLimit
    view:view
              completionHandler: ^(ManagedApplications output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ManagedApplicationsApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given Id.
var opts = { 
  'filter': filter_example, // {{String}} The date filter to query the managed applications. Supported fields in the filter are [modifiedAt, productId]
  'orderBy': orderBy_example, // {{String}} The order by filter to sort the managed applications. Supported fields in the orderBy are [modifiedAt]
  'skipToken': skipToken_example, // {{String}} Used in pagination to point to the next set of records.
  'paginationLimit': paginationLimit_example, // {{String}} Custom pagination limit to be used.
  'view': view_example // {{String}} View for managed applications.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.managed_ApplicationsIndex(orgId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class managed_ApplicationsIndexExample
    {
        public void main()
        {


            var apiInstance = new ManagedApplicationsApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given Id.
            var filter = filter_example;  // String | The date filter to query the managed applications. Supported fields in the filter are [modifiedAt, productId] (optional) 
            var orderBy = orderBy_example;  // String | The order by filter to sort the managed applications. Supported fields in the orderBy are [modifiedAt] (optional)  (default to modifiedAt desc)
            var skipToken = skipToken_example;  // String | Used in pagination to point to the next set of records. (optional) 
            var paginationLimit = paginationLimit_example;  // String | Custom pagination limit to be used. (optional) 
            var view = view_example;  // String | View for managed applications. (optional) 

            try
            {
                // List managed applications.
                ManagedApplications result = apiInstance.managed_ApplicationsIndex(orgId, filter, orderBy, skipToken, paginationLimit, view);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagedApplicationsApi.managed_ApplicationsIndex: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiManagedApplicationsApi();
$orgId = orgId_example; // String | orgId identifies an organization by given Id.
$filter = filter_example; // String | The date filter to query the managed applications. Supported fields in the filter are [modifiedAt, productId]
$orderBy = orderBy_example; // String | The order by filter to sort the managed applications. Supported fields in the orderBy are [modifiedAt]
$skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
$paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
$view = view_example; // String | View for managed applications.

try {
    $result = $api_instance->managed_ApplicationsIndex($orgId, $filter, $orderBy, $skipToken, $paginationLimit, $view);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagedApplicationsApi->managed_ApplicationsIndex: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagedApplicationsApi;


my $api_instance = WWW::SwaggerClient::ManagedApplicationsApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given Id.
my $filter = filter_example; # String | The date filter to query the managed applications. Supported fields in the filter are [modifiedAt, productId]
my $orderBy = orderBy_example; # String | The order by filter to sort the managed applications. Supported fields in the orderBy are [modifiedAt]
my $skipToken = skipToken_example; # String | Used in pagination to point to the next set of records.
my $paginationLimit = paginationLimit_example; # String | Custom pagination limit to be used.
my $view = view_example; # String | View for managed applications.

eval { 
    my $result = $api_instance->managed_ApplicationsIndex(orgId => $orgId, filter => $filter, orderBy => $orderBy, skipToken => $skipToken, paginationLimit => $paginationLimit, view => $view);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagedApplicationsApi->managed_ApplicationsIndex: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ManagedApplicationsApi()
orgId = orgId_example # String | orgId identifies an organization by given Id.
filter = filter_example # String | The date filter to query the managed applications. Supported fields in the filter are [modifiedAt, productId] (optional)
orderBy = orderBy_example # String | The order by filter to sort the managed applications. Supported fields in the orderBy are [modifiedAt] (optional) (default to modifiedAt desc)
skipToken = skipToken_example # String | Used in pagination to point to the next set of records. (optional)
paginationLimit = paginationLimit_example # String | Custom pagination limit to be used. (optional)
view = view_example # String | View for managed applications. (optional)

try: 
    # List managed applications.
    api_response = api_instance.managed_applications_index(orgId, filter=filter, orderBy=orderBy, skipToken=skipToken, paginationLimit=paginationLimit, view=view)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagedApplicationsApi->managed_ApplicationsIndex: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given Id.
Required
Query parameters
Name Description
filter
String
The date filter to query the managed applications. Supported fields in the filter are [modifiedAt, productId]
orderBy
String
The order by filter to sort the managed applications. Supported fields in the orderBy are [modifiedAt]
skipToken
String
Used in pagination to point to the next set of records.
paginationLimit
String
Custom pagination limit to be used.
view
String
View for managed applications.

Responses

Status: 200 - OK response.

{"nextPage":"/orgs/1/managed-apps?skipToken=b2NjdXJyZWQgZ3QgJzE5NzAtMDEtMDFUMDA6MDA6MDBaJyNvY2N1cnJlZCBkZXNjIzEjNTU2NDg5MDgz","values":[{"activityThreshold":30,"annualCost":"25000.00","appId":"123","appName":"Office 365","categoryGroupName":"Productivity","categoryName":"Productivity","description":"Office 365","id":"123","integrationType":"Direct","isUnlimited":true,"modifiedAt":"2018-05-16T16:31:52.1000Z","name":"Office 365","pointOfContact":"test@metasaas.com","subCategoryName":"Productivity Suites","tags":"Collaboration,Task Management","totalActive":"200","totalLicenses ":"1500","totalUsers":"1000","vendorName":"Microsoft"},{"activityThreshold":30,"annualCost":"25000.00","appId":"123","appName":"Office 365","categoryGroupName":"Productivity","categoryName":"Productivity","description":"Office 365","id":"123","integrationType":"Direct","isUnlimited":true,"modifiedAt":"2018-05-16T16:31:52.1000Z","name":"Office 365","pointOfContact":"test@metasaas.com","subCategoryName":"Productivity Suites","tags":"Collaboration,Task Management","totalActive":"200","totalLicenses ":"1500","totalUsers":"1000","vendorName":"Microsoft"}]}

Status: 400 - Bad Request response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Show

Show managed application.

Retrieves a managed application identified by ID.


/saas/v1/orgs/{orgId}/managed-apps/{managedAppId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/managed-apps/{managedAppId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagedApplicationsApi;

import java.io.File;
import java.util.*;

public class ManagedApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ManagedApplicationsApi apiInstance = new ManagedApplicationsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String managedAppId = managedAppId_example; // String | managedAppId identifies an managed application by given ID.
        try {
            FlexeraFsmManagedapplication result = apiInstance.managed_ApplicationsShow(orgId, managedAppId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationsApi#managed_ApplicationsShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagedApplicationsApi;

public class ManagedApplicationsApiExample {

    public static void main(String[] args) {
        ManagedApplicationsApi apiInstance = new ManagedApplicationsApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String managedAppId = managedAppId_example; // String | managedAppId identifies an managed application by given ID.
        try {
            FlexeraFsmManagedapplication result = apiInstance.managed_ApplicationsShow(orgId, managedAppId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationsApi#managed_ApplicationsShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given ID.
String *managedAppId = managedAppId_example; // managedAppId identifies an managed application by given ID.

ManagedApplicationsApi *apiInstance = [[ManagedApplicationsApi alloc] init];

// Show managed application.
[apiInstance managed_ApplicationsShowWith:orgId
    managedAppId:managedAppId
              completionHandler: ^(FlexeraFsmManagedapplication output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ManagedApplicationsApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.
var managedAppId = managedAppId_example; // {{String}} managedAppId identifies an managed application by given ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.managed_ApplicationsShow(orgId, managedAppId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class managed_ApplicationsShowExample
    {
        public void main()
        {


            var apiInstance = new ManagedApplicationsApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.
            var managedAppId = managedAppId_example;  // String | managedAppId identifies an managed application by given ID.

            try
            {
                // Show managed application.
                FlexeraFsmManagedapplication result = apiInstance.managed_ApplicationsShow(orgId, managedAppId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagedApplicationsApi.managed_ApplicationsShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiManagedApplicationsApi();
$orgId = orgId_example; // String | orgId identifies an organization by given ID.
$managedAppId = managedAppId_example; // String | managedAppId identifies an managed application by given ID.

try {
    $result = $api_instance->managed_ApplicationsShow($orgId, $managedAppId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagedApplicationsApi->managed_ApplicationsShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagedApplicationsApi;


my $api_instance = WWW::SwaggerClient::ManagedApplicationsApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.
my $managedAppId = managedAppId_example; # String | managedAppId identifies an managed application by given ID.

eval { 
    my $result = $api_instance->managed_ApplicationsShow(orgId => $orgId, managedAppId => $managedAppId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagedApplicationsApi->managed_ApplicationsShow: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ManagedApplicationsApi()
orgId = orgId_example # String | orgId identifies an organization by given ID.
managedAppId = managedAppId_example # String | managedAppId identifies an managed application by given ID.

try: 
    # Show managed application.
    api_response = api_instance.managed_applications_show(orgId, managedAppId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagedApplicationsApi->managed_ApplicationsShow: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required
managedAppId*
String
managedAppId identifies an managed application by given ID.
Required

Responses

Status: 200 - OK response.

{"activityThreshold":45,"annualCost":"25000.00","appId":"123","appName":"Office 365","categoryGroupName":"Productivity","categoryName":"Productivity","description":"Office 365","id":"123","integrationType":"Direct","isUnlimited":true,"modifiedAt":"2018-05-16T16:31:52.1000Z","name":"Office 365","pointOfContact":"test@metasaas.com","subCategoryName":"Productivity Suites","tags":"Collaboration,Task Management","totalActive":"200","totalLicenses ":"1500","totalUsers":"1000","vendorName":"Microsoft"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Update

Update managed application.

Updates a managed application identified by ID.


/saas/v1/orgs/{orgId}/managed-apps/{managedAppId}

Usage and SDK Samples

curl -X PATCH\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/vnd.goa.error"\
-H "Content-Type: application/json"\
"http://localhost:80/saas/v1/orgs/{orgId}/managed-apps/{managedAppId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagedApplicationsApi;

import java.io.File;
import java.util.*;

public class ManagedApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ManagedApplicationsApi apiInstance = new ManagedApplicationsApi();
        UpdateRequestBody body = {
  "activityThreshold" : 1,
  "description" : "Office 365",
  "isActive" : true,
  "name" : "Office 365",
  "pointOfContact" : "test@metasaas.com"
}; // UpdateRequestBody | 
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String managedAppId = managedAppId_example; // String | 
        try {
            apiInstance.managed_ApplicationsUpdate(body, orgId, managedAppId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationsApi#managed_ApplicationsUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagedApplicationsApi;

public class ManagedApplicationsApiExample {

    public static void main(String[] args) {
        ManagedApplicationsApi apiInstance = new ManagedApplicationsApi();
        UpdateRequestBody body = {
  "activityThreshold" : 1,
  "description" : "Office 365",
  "isActive" : true,
  "name" : "Office 365",
  "pointOfContact" : "test@metasaas.com"
}; // UpdateRequestBody | 
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String managedAppId = managedAppId_example; // String | 
        try {
            apiInstance.managed_ApplicationsUpdate(body, orgId, managedAppId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagedApplicationsApi#managed_ApplicationsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
UpdateRequestBody *body = {
  "activityThreshold" : 1,
  "description" : "Office 365",
  "isActive" : true,
  "name" : "Office 365",
  "pointOfContact" : "test@metasaas.com"
}; // 
String *orgId = orgId_example; // orgId identifies an organization by given ID.
String *managedAppId = managedAppId_example; // 

ManagedApplicationsApi *apiInstance = [[ManagedApplicationsApi alloc] init];

// Update managed application.
[apiInstance managed_ApplicationsUpdateWith:body
    orgId:orgId
    managedAppId:managedAppId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ManagedApplicationsApi()
var body = {
  "activityThreshold" : 1,
  "description" : "Office 365",
  "isActive" : true,
  "name" : "Office 365",
  "pointOfContact" : "test@metasaas.com"
}; // {{UpdateRequestBody}} 
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.
var managedAppId = managedAppId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.managed_ApplicationsUpdate(bodyorgIdmanagedAppId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class managed_ApplicationsUpdateExample
    {
        public void main()
        {


            var apiInstance = new ManagedApplicationsApi();
            var body = new UpdateRequestBody(); // UpdateRequestBody | 
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.
            var managedAppId = managedAppId_example;  // String | 

            try
            {
                // Update managed application.
                apiInstance.managed_ApplicationsUpdate(body, orgId, managedAppId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagedApplicationsApi.managed_ApplicationsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiManagedApplicationsApi();
$body = {
  "activityThreshold" : 1,
  "description" : "Office 365",
  "isActive" : true,
  "name" : "Office 365",
  "pointOfContact" : "test@metasaas.com"
}; // UpdateRequestBody | 
$orgId = orgId_example; // String | orgId identifies an organization by given ID.
$managedAppId = managedAppId_example; // String | 

try {
    $api_instance->managed_ApplicationsUpdate($body, $orgId, $managedAppId);
} catch (Exception $e) {
    echo 'Exception when calling ManagedApplicationsApi->managed_ApplicationsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagedApplicationsApi;


my $api_instance = WWW::SwaggerClient::ManagedApplicationsApi->new();
my $body = WWW::SwaggerClient::Object::UpdateRequestBody->new(); # UpdateRequestBody | 
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.
my $managedAppId = managedAppId_example; # String | 

eval { 
    $api_instance->managed_ApplicationsUpdate(body => $body, orgId => $orgId, managedAppId => $managedAppId);
};
if ($@) {
    warn "Exception when calling ManagedApplicationsApi->managed_ApplicationsUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ManagedApplicationsApi()
body = {
  "activityThreshold" : 1,
  "description" : "Office 365",
  "isActive" : true,
  "name" : "Office 365",
  "pointOfContact" : "test@metasaas.com"
} # UpdateRequestBody | 
orgId = orgId_example # String | orgId identifies an organization by given ID.
managedAppId = managedAppId_example # String | 

try: 
    # Update managed application.
    api_instance.managed_applications_update(body, orgId, managedAppId)
except ApiException as e:
    print("Exception when calling ManagedApplicationsApi->managed_ApplicationsUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required
managedAppId*
String
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK response.

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Metric Query

Query

Query metrics service.

The query endpoint takes in a metric query request, pulls the relevant raw data from the metrics service and, marshals the result into a query result.


/saas/v1/orgs/{orgId}/stored-metric-queries/{queryName}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
-H "Content-Type: application/json"\
"http://localhost:80/saas/v1/orgs/{orgId}/stored-metric-queries/{queryName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MetricQueryApi;

import java.io.File;
import java.util.*;

public class MetricQueryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        MetricQueryApi apiInstance = new MetricQueryApi();
        QueryRequestBody body = {
  "dimensions" : [ "group" ],
  "filter" : "date ge 2020-02-01 AND date lt 2020-10-01 AND managedAppId eq 1234 AND groupType eq department",
  "granularity" : "month",
  "metrics" : [ "costTotalAmortized", "numOfTotal", "costTotalAmortized", "costTotalAmortized" ]
}; // QueryRequestBody | 
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String queryName = queryName_example; // String | queryName identifies a query to execute and return results.
        try {
            MetricQueryResultCollection result = apiInstance.metric_QueryQuery(body, orgId, queryName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricQueryApi#metric_QueryQuery");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetricQueryApi;

public class MetricQueryApiExample {

    public static void main(String[] args) {
        MetricQueryApi apiInstance = new MetricQueryApi();
        QueryRequestBody body = {
  "dimensions" : [ "group" ],
  "filter" : "date ge 2020-02-01 AND date lt 2020-10-01 AND managedAppId eq 1234 AND groupType eq department",
  "granularity" : "month",
  "metrics" : [ "costTotalAmortized", "numOfTotal", "costTotalAmortized", "costTotalAmortized" ]
}; // QueryRequestBody | 
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String queryName = queryName_example; // String | queryName identifies a query to execute and return results.
        try {
            MetricQueryResultCollection result = apiInstance.metric_QueryQuery(body, orgId, queryName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricQueryApi#metric_QueryQuery");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
QueryRequestBody *body = {
  "dimensions" : [ "group" ],
  "filter" : "date ge 2020-02-01 AND date lt 2020-10-01 AND managedAppId eq 1234 AND groupType eq department",
  "granularity" : "month",
  "metrics" : [ "costTotalAmortized", "numOfTotal", "costTotalAmortized", "costTotalAmortized" ]
}; // 
String *orgId = orgId_example; // orgId identifies an organization by given Id.
String *queryName = queryName_example; // queryName identifies a query to execute and return results.

MetricQueryApi *apiInstance = [[MetricQueryApi alloc] init];

// Query metrics service.
[apiInstance metric_QueryQueryWith:body
    orgId:orgId
    queryName:queryName
              completionHandler: ^(MetricQueryResultCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.MetricQueryApi()
var body = {
  "dimensions" : [ "group" ],
  "filter" : "date ge 2020-02-01 AND date lt 2020-10-01 AND managedAppId eq 1234 AND groupType eq department",
  "granularity" : "month",
  "metrics" : [ "costTotalAmortized", "numOfTotal", "costTotalAmortized", "costTotalAmortized" ]
}; // {{QueryRequestBody}} 
var orgId = orgId_example; // {{String}} orgId identifies an organization by given Id.
var queryName = queryName_example; // {{String}} queryName identifies a query to execute and return results.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.metric_QueryQuery(bodyorgIdqueryName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class metric_QueryQueryExample
    {
        public void main()
        {


            var apiInstance = new MetricQueryApi();
            var body = new QueryRequestBody(); // QueryRequestBody | 
            var orgId = orgId_example;  // String | orgId identifies an organization by given Id.
            var queryName = queryName_example;  // String | queryName identifies a query to execute and return results.

            try
            {
                // Query metrics service.
                MetricQueryResultCollection result = apiInstance.metric_QueryQuery(body, orgId, queryName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetricQueryApi.metric_QueryQuery: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMetricQueryApi();
$body = {
  "dimensions" : [ "group" ],
  "filter" : "date ge 2020-02-01 AND date lt 2020-10-01 AND managedAppId eq 1234 AND groupType eq department",
  "granularity" : "month",
  "metrics" : [ "costTotalAmortized", "numOfTotal", "costTotalAmortized", "costTotalAmortized" ]
}; // QueryRequestBody | 
$orgId = orgId_example; // String | orgId identifies an organization by given Id.
$queryName = queryName_example; // String | queryName identifies a query to execute and return results.

try {
    $result = $api_instance->metric_QueryQuery($body, $orgId, $queryName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetricQueryApi->metric_QueryQuery: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetricQueryApi;


my $api_instance = WWW::SwaggerClient::MetricQueryApi->new();
my $body = WWW::SwaggerClient::Object::QueryRequestBody->new(); # QueryRequestBody | 
my $orgId = orgId_example; # String | orgId identifies an organization by given Id.
my $queryName = queryName_example; # String | queryName identifies a query to execute and return results.

eval { 
    my $result = $api_instance->metric_QueryQuery(body => $body, orgId => $orgId, queryName => $queryName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MetricQueryApi->metric_QueryQuery: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.MetricQueryApi()
body = {
  "dimensions" : [ "group" ],
  "filter" : "date ge 2020-02-01 AND date lt 2020-10-01 AND managedAppId eq 1234 AND groupType eq department",
  "granularity" : "month",
  "metrics" : [ "costTotalAmortized", "numOfTotal", "costTotalAmortized", "costTotalAmortized" ]
} # QueryRequestBody | 
orgId = orgId_example # String | orgId identifies an organization by given Id.
queryName = queryName_example # String | queryName identifies a query to execute and return results.

try: 
    # Query metrics service.
    api_response = api_instance.metric_query_query(body, orgId, queryName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricQueryApi->metric_QueryQuery: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given Id.
Required
queryName*
String
queryName identifies a query to execute and return results.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK response.

[{"date":"2020-02-01","dimensions":{"group":"Engineering","resourceStatus":"active","resourceType":"appUser"},"managedAppId":"123","metrics":{"costTotalAmortized":88888,"numOfTotal":99999}},{"date":"2020-02-01","dimensions":{"group":"Engineering","resourceStatus":"active","resourceType":"appUser"},"managedAppId":"123","metrics":{"costTotalAmortized":88888,"numOfTotal":99999}},{"date":"2020-02-01","dimensions":{"group":"Engineering","resourceStatus":"active","resourceType":"appUser"},"managedAppId":"123","metrics":{"costTotalAmortized":88888,"numOfTotal":99999}},{"date":"2020-02-01","dimensions":{"group":"Engineering","resourceStatus":"active","resourceType":"appUser"},"managedAppId":"123","metrics":{"costTotalAmortized":88888,"numOfTotal":99999}}]

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

People

Aliases

List aliases of a person.

Retrieves all known aliases of a person identified by personId.


/saas/v1/orgs/{orgId}/people/{personId}/aliases

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/people/{personId}/aliases?filter=&orderBy=&skipToken=&paginationLimit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PeopleApi;

import java.io.File;
import java.util.*;

public class PeopleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PeopleApi apiInstance = new PeopleApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String personId = personId_example; // String | personId identifies a person by given ID.
        String filter = filter_example; // String | The filter to query the saas person aliases. Supported fields in the filter are [alias]
        String orderBy = orderBy_example; // String | The order by filter to sort the saas person alias. Supported fields in the orderBy are [createdAt,alias]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        try {
            SaasPersonAliases result = apiInstance.peopleAliases(orgId, personId, filter, orderBy, skipToken, paginationLimit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeopleApi#peopleAliases");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PeopleApi;

public class PeopleApiExample {

    public static void main(String[] args) {
        PeopleApi apiInstance = new PeopleApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String personId = personId_example; // String | personId identifies a person by given ID.
        String filter = filter_example; // String | The filter to query the saas person aliases. Supported fields in the filter are [alias]
        String orderBy = orderBy_example; // String | The order by filter to sort the saas person alias. Supported fields in the orderBy are [createdAt,alias]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        try {
            SaasPersonAliases result = apiInstance.peopleAliases(orgId, personId, filter, orderBy, skipToken, paginationLimit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeopleApi#peopleAliases");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given ID.
String *personId = personId_example; // personId identifies a person by given ID.
String *filter = filter_example; // The filter to query the saas person aliases. Supported fields in the filter are [alias] (optional)
String *orderBy = orderBy_example; // The order by filter to sort the saas person alias. Supported fields in the orderBy are [createdAt,alias] (optional) (default to createdAt asc)
String *skipToken = skipToken_example; // Used in pagination to point to the next set of records. (optional)
String *paginationLimit = paginationLimit_example; // Custom pagination limit to be used. (optional)

PeopleApi *apiInstance = [[PeopleApi alloc] init];

// List aliases of a person.
[apiInstance peopleAliasesWith:orgId
    personId:personId
    filter:filter
    orderBy:orderBy
    skipToken:skipToken
    paginationLimit:paginationLimit
              completionHandler: ^(SaasPersonAliases output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.PeopleApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.
var personId = personId_example; // {{String}} personId identifies a person by given ID.
var opts = { 
  'filter': filter_example, // {{String}} The filter to query the saas person aliases. Supported fields in the filter are [alias]
  'orderBy': orderBy_example, // {{String}} The order by filter to sort the saas person alias. Supported fields in the orderBy are [createdAt,alias]
  'skipToken': skipToken_example, // {{String}} Used in pagination to point to the next set of records.
  'paginationLimit': paginationLimit_example // {{String}} Custom pagination limit to be used.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.peopleAliases(orgId, personId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class peopleAliasesExample
    {
        public void main()
        {


            var apiInstance = new PeopleApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.
            var personId = personId_example;  // String | personId identifies a person by given ID.
            var filter = filter_example;  // String | The filter to query the saas person aliases. Supported fields in the filter are [alias] (optional) 
            var orderBy = orderBy_example;  // String | The order by filter to sort the saas person alias. Supported fields in the orderBy are [createdAt,alias] (optional)  (default to createdAt asc)
            var skipToken = skipToken_example;  // String | Used in pagination to point to the next set of records. (optional) 
            var paginationLimit = paginationLimit_example;  // String | Custom pagination limit to be used. (optional) 

            try
            {
                // List aliases of a person.
                SaasPersonAliases result = apiInstance.peopleAliases(orgId, personId, filter, orderBy, skipToken, paginationLimit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PeopleApi.peopleAliases: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPeopleApi();
$orgId = orgId_example; // String | orgId identifies an organization by given ID.
$personId = personId_example; // String | personId identifies a person by given ID.
$filter = filter_example; // String | The filter to query the saas person aliases. Supported fields in the filter are [alias]
$orderBy = orderBy_example; // String | The order by filter to sort the saas person alias. Supported fields in the orderBy are [createdAt,alias]
$skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
$paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.

try {
    $result = $api_instance->peopleAliases($orgId, $personId, $filter, $orderBy, $skipToken, $paginationLimit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PeopleApi->peopleAliases: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PeopleApi;


my $api_instance = WWW::SwaggerClient::PeopleApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.
my $personId = personId_example; # String | personId identifies a person by given ID.
my $filter = filter_example; # String | The filter to query the saas person aliases. Supported fields in the filter are [alias]
my $orderBy = orderBy_example; # String | The order by filter to sort the saas person alias. Supported fields in the orderBy are [createdAt,alias]
my $skipToken = skipToken_example; # String | Used in pagination to point to the next set of records.
my $paginationLimit = paginationLimit_example; # String | Custom pagination limit to be used.

eval { 
    my $result = $api_instance->peopleAliases(orgId => $orgId, personId => $personId, filter => $filter, orderBy => $orderBy, skipToken => $skipToken, paginationLimit => $paginationLimit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PeopleApi->peopleAliases: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.PeopleApi()
orgId = orgId_example # String | orgId identifies an organization by given ID.
personId = personId_example # String | personId identifies a person by given ID.
filter = filter_example # String | The filter to query the saas person aliases. Supported fields in the filter are [alias] (optional)
orderBy = orderBy_example # String | The order by filter to sort the saas person alias. Supported fields in the orderBy are [createdAt,alias] (optional) (default to createdAt asc)
skipToken = skipToken_example # String | Used in pagination to point to the next set of records. (optional)
paginationLimit = paginationLimit_example # String | Custom pagination limit to be used. (optional)

try: 
    # List aliases of a person.
    api_response = api_instance.people_aliases(orgId, personId, filter=filter, orderBy=orderBy, skipToken=skipToken, paginationLimit=paginationLimit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PeopleApi->peopleAliases: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required
personId*
String
personId identifies a person by given ID.
Required
Query parameters
Name Description
filter
String
The filter to query the saas person aliases. Supported fields in the filter are [alias]
orderBy
String
The order by filter to sort the saas person alias. Supported fields in the orderBy are [createdAt,alias]
skipToken
String
Used in pagination to point to the next set of records.
paginationLimit
String
Custom pagination limit to be used.

Responses

Status: 200 - OK response.

{"nextPage":"/orgs/1/people/123/aliases?skipToken=b2NjdXJyZWQgZ3QgJzE5NzAtMDEtMDFUMDA6MDA6MDBaJyNvY2N1cnJlZCBkZXNjIzEjNTU2NDg5MDgz","values":[{"alias":"gwashington@unitedstatespresident.gov","createdAt":"2018-05-16T16:31:52.1000Z","personHref":"/ods/v0/orgs/123/people/123"},{"alias":"gwashington@unitedstatespresident.gov","createdAt":"2018-05-16T16:31:52.1000Z","personHref":"/ods/v0/orgs/123/people/123"}]}

Status: 400 - Bad Request response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Index

List people.

Retrieves a collection of people.


/saas/v1/orgs/{orgId}/people

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/people?filter=&orderBy=&skipToken=&paginationLimit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PeopleApi;

import java.io.File;
import java.util.*;

public class PeopleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PeopleApi apiInstance = new PeopleApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | The filter to query the saas persons. Supported fields in the filter are [firstName,lastName,email,sourceUniqueId,acquiringResourceDisplayName]
        String orderBy = orderBy_example; // String | The order by filter to sort the saas persons. Supported fields in the orderBy are [activatedAt,deactivatedAt]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        try {
            SaasPersons result = apiInstance.peopleIndex(orgId, filter, orderBy, skipToken, paginationLimit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeopleApi#peopleIndex");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PeopleApi;

public class PeopleApiExample {

    public static void main(String[] args) {
        PeopleApi apiInstance = new PeopleApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | The filter to query the saas persons. Supported fields in the filter are [firstName,lastName,email,sourceUniqueId,acquiringResourceDisplayName]
        String orderBy = orderBy_example; // String | The order by filter to sort the saas persons. Supported fields in the orderBy are [activatedAt,deactivatedAt]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        try {
            SaasPersons result = apiInstance.peopleIndex(orgId, filter, orderBy, skipToken, paginationLimit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeopleApi#peopleIndex");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given Id.
String *filter = filter_example; // The filter to query the saas persons. Supported fields in the filter are [firstName,lastName,email,sourceUniqueId,acquiringResourceDisplayName] (optional)
String *orderBy = orderBy_example; // The order by filter to sort the saas persons. Supported fields in the orderBy are [activatedAt,deactivatedAt] (optional) (default to activatedAt desc)
String *skipToken = skipToken_example; // Used in pagination to point to the next set of records. (optional)
String *paginationLimit = paginationLimit_example; // Custom pagination limit to be used. (optional)

PeopleApi *apiInstance = [[PeopleApi alloc] init];

// List people.
[apiInstance peopleIndexWith:orgId
    filter:filter
    orderBy:orderBy
    skipToken:skipToken
    paginationLimit:paginationLimit
              completionHandler: ^(SaasPersons output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.PeopleApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given Id.
var opts = { 
  'filter': filter_example, // {{String}} The filter to query the saas persons. Supported fields in the filter are [firstName,lastName,email,sourceUniqueId,acquiringResourceDisplayName]
  'orderBy': orderBy_example, // {{String}} The order by filter to sort the saas persons. Supported fields in the orderBy are [activatedAt,deactivatedAt]
  'skipToken': skipToken_example, // {{String}} Used in pagination to point to the next set of records.
  'paginationLimit': paginationLimit_example // {{String}} Custom pagination limit to be used.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.peopleIndex(orgId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class peopleIndexExample
    {
        public void main()
        {


            var apiInstance = new PeopleApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given Id.
            var filter = filter_example;  // String | The filter to query the saas persons. Supported fields in the filter are [firstName,lastName,email,sourceUniqueId,acquiringResourceDisplayName] (optional) 
            var orderBy = orderBy_example;  // String | The order by filter to sort the saas persons. Supported fields in the orderBy are [activatedAt,deactivatedAt] (optional)  (default to activatedAt desc)
            var skipToken = skipToken_example;  // String | Used in pagination to point to the next set of records. (optional) 
            var paginationLimit = paginationLimit_example;  // String | Custom pagination limit to be used. (optional) 

            try
            {
                // List people.
                SaasPersons result = apiInstance.peopleIndex(orgId, filter, orderBy, skipToken, paginationLimit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PeopleApi.peopleIndex: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPeopleApi();
$orgId = orgId_example; // String | orgId identifies an organization by given Id.
$filter = filter_example; // String | The filter to query the saas persons. Supported fields in the filter are [firstName,lastName,email,sourceUniqueId,acquiringResourceDisplayName]
$orderBy = orderBy_example; // String | The order by filter to sort the saas persons. Supported fields in the orderBy are [activatedAt,deactivatedAt]
$skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
$paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.

try {
    $result = $api_instance->peopleIndex($orgId, $filter, $orderBy, $skipToken, $paginationLimit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PeopleApi->peopleIndex: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PeopleApi;


my $api_instance = WWW::SwaggerClient::PeopleApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given Id.
my $filter = filter_example; # String | The filter to query the saas persons. Supported fields in the filter are [firstName,lastName,email,sourceUniqueId,acquiringResourceDisplayName]
my $orderBy = orderBy_example; # String | The order by filter to sort the saas persons. Supported fields in the orderBy are [activatedAt,deactivatedAt]
my $skipToken = skipToken_example; # String | Used in pagination to point to the next set of records.
my $paginationLimit = paginationLimit_example; # String | Custom pagination limit to be used.

eval { 
    my $result = $api_instance->peopleIndex(orgId => $orgId, filter => $filter, orderBy => $orderBy, skipToken => $skipToken, paginationLimit => $paginationLimit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PeopleApi->peopleIndex: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.PeopleApi()
orgId = orgId_example # String | orgId identifies an organization by given Id.
filter = filter_example # String | The filter to query the saas persons. Supported fields in the filter are [firstName,lastName,email,sourceUniqueId,acquiringResourceDisplayName] (optional)
orderBy = orderBy_example # String | The order by filter to sort the saas persons. Supported fields in the orderBy are [activatedAt,deactivatedAt] (optional) (default to activatedAt desc)
skipToken = skipToken_example # String | Used in pagination to point to the next set of records. (optional)
paginationLimit = paginationLimit_example # String | Custom pagination limit to be used. (optional)

try: 
    # List people.
    api_response = api_instance.people_index(orgId, filter=filter, orderBy=orderBy, skipToken=skipToken, paginationLimit=paginationLimit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PeopleApi->peopleIndex: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given Id.
Required
Query parameters
Name Description
filter
String
The filter to query the saas persons. Supported fields in the filter are [firstName,lastName,email,sourceUniqueId,acquiringResourceDisplayName]
orderBy
String
The order by filter to sort the saas persons. Supported fields in the orderBy are [activatedAt,deactivatedAt]
skipToken
String
Used in pagination to point to the next set of records.
paginationLimit
String
Custom pagination limit to be used.

Responses

Status: 200 - OK response.

{"nextPage":"/orgs/1/people?skipToken=b2NjdXJyZWQgZ3QgJzE5NzAtMDEtMDFUMDA6MDA6MDBaJyNvY2N1cnJlZCBkZXNjIzEjNTU2NDg5MDgz","values":[{"activatedAt":"2018-05-16T16:31:52.1000Z","createdAt":"2018-05-16T16:31:52.1000Z","deactivatedAt":"2018-05-16T16:31:52.1000Z","email":"test@metasaas.com","firstName":"John","id":"123","lastName":"Collins","metadata":{"acquiringResourceDisplayName":"Microsoft 365 Engineering instance","acquiringResourceHref":"/saas/v1/orgs/432/managed-app/123","sourceUniqueId":"123123abcdef"},"middleName":"James","modifiedAt":"2018-05-16T16:31:52.1000Z","uniqueId":"123"},{"activatedAt":"2018-05-16T16:31:52.1000Z","createdAt":"2018-05-16T16:31:52.1000Z","deactivatedAt":"2018-05-16T16:31:52.1000Z","email":"test@metasaas.com","firstName":"John","id":"123","lastName":"Collins","metadata":{"acquiringResourceDisplayName":"Microsoft 365 Engineering instance","acquiringResourceHref":"/saas/v1/orgs/432/managed-app/123","sourceUniqueId":"123123abcdef"},"middleName":"James","modifiedAt":"2018-05-16T16:31:52.1000Z","uniqueId":"123"}]}

Status: 400 - Bad Request response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Show

Show saas person.

Retrieves a saas person identified by personId.


/saas/v1/orgs/{orgId}/people/{personId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/vnd.goa.error,application/json"\
"http://localhost:80/saas/v1/orgs/{orgId}/people/{personId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PeopleApi;

import java.io.File;
import java.util.*;

public class PeopleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PeopleApi apiInstance = new PeopleApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String personId = personId_example; // String | personId identifies a person by given ID.
        try {
            FlexeraFsmPerson result = apiInstance.peopleShow(orgId, personId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeopleApi#peopleShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PeopleApi;

public class PeopleApiExample {

    public static void main(String[] args) {
        PeopleApi apiInstance = new PeopleApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String personId = personId_example; // String | personId identifies a person by given ID.
        try {
            FlexeraFsmPerson result = apiInstance.peopleShow(orgId, personId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeopleApi#peopleShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given ID.
String *personId = personId_example; // personId identifies a person by given ID.

PeopleApi *apiInstance = [[PeopleApi alloc] init];

// Show saas person.
[apiInstance peopleShowWith:orgId
    personId:personId
              completionHandler: ^(FlexeraFsmPerson output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.PeopleApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.
var personId = personId_example; // {{String}} personId identifies a person by given ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.peopleShow(orgId, personId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class peopleShowExample
    {
        public void main()
        {


            var apiInstance = new PeopleApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.
            var personId = personId_example;  // String | personId identifies a person by given ID.

            try
            {
                // Show saas person.
                FlexeraFsmPerson result = apiInstance.peopleShow(orgId, personId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PeopleApi.peopleShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPeopleApi();
$orgId = orgId_example; // String | orgId identifies an organization by given ID.
$personId = personId_example; // String | personId identifies a person by given ID.

try {
    $result = $api_instance->peopleShow($orgId, $personId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PeopleApi->peopleShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PeopleApi;


my $api_instance = WWW::SwaggerClient::PeopleApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.
my $personId = personId_example; # String | personId identifies a person by given ID.

eval { 
    my $result = $api_instance->peopleShow(orgId => $orgId, personId => $personId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PeopleApi->peopleShow: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.PeopleApi()
orgId = orgId_example # String | orgId identifies an organization by given ID.
personId = personId_example # String | personId identifies a person by given ID.

try: 
    # Show saas person.
    api_response = api_instance.people_show(orgId, personId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PeopleApi->peopleShow: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required
personId*
String
personId identifies a person by given ID.
Required

Responses

Status: 5 - response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 200 - OK response.

{"activatedAt":"2018-05-16T16:31:52.1000Z","createdAt":"2018-05-16T16:31:52.1000Z","deactivatedAt":"2018-05-16T16:31:52.1000Z","email":"test@metasaas.com","firstName":"John","id":"123","lastName":"Collins","metadata":{"acquiringResourceDisplayName":"Microsoft 365 Engineering instance","acquiringResourceHref":"/saas/v1/orgs/432/managed-app/123","sourceUniqueId":"123123abcdef"},"middleName":"James","modifiedAt":"2018-05-16T16:31:52.1000Z","uniqueId":"123"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Reclamation State

Index

List reclamation states.

Retrieves a collection of reclamation states.


/saas/v1/orgs/{orgId}/reclamation-states

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/reclamation-states?filter=&orderBy=&skipToken=&paginationLimit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReclamationStateApi;

import java.io.File;
import java.util.*;

public class ReclamationStateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ReclamationStateApi apiInstance = new ReclamationStateApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | The filter to query the reclamation state. Supported fields in the filter are [state, appUserId, managedAppId]
        String orderBy = orderBy_example; // String | Fields by which the results should be ordered. Supported fields in the orderBy are [state, managedAppId]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        try {
            ReclamationStates result = apiInstance.reclamation_StateIndex(orgId, filter, orderBy, skipToken, paginationLimit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReclamationStateApi#reclamation_StateIndex");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReclamationStateApi;

public class ReclamationStateApiExample {

    public static void main(String[] args) {
        ReclamationStateApi apiInstance = new ReclamationStateApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given Id.
        String filter = filter_example; // String | The filter to query the reclamation state. Supported fields in the filter are [state, appUserId, managedAppId]
        String orderBy = orderBy_example; // String | Fields by which the results should be ordered. Supported fields in the orderBy are [state, managedAppId]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
        try {
            ReclamationStates result = apiInstance.reclamation_StateIndex(orgId, filter, orderBy, skipToken, paginationLimit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReclamationStateApi#reclamation_StateIndex");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given Id.
String *filter = filter_example; // The filter to query the reclamation state. Supported fields in the filter are [state, appUserId, managedAppId] (optional)
String *orderBy = orderBy_example; // Fields by which the results should be ordered. Supported fields in the orderBy are [state, managedAppId] (optional) (default to state desc)
String *skipToken = skipToken_example; // Used in pagination to point to the next set of records. (optional)
String *paginationLimit = paginationLimit_example; // Custom pagination limit to be used. (optional)

ReclamationStateApi *apiInstance = [[ReclamationStateApi alloc] init];

// List reclamation states.
[apiInstance reclamation_StateIndexWith:orgId
    filter:filter
    orderBy:orderBy
    skipToken:skipToken
    paginationLimit:paginationLimit
              completionHandler: ^(ReclamationStates output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ReclamationStateApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given Id.
var opts = { 
  'filter': filter_example, // {{String}} The filter to query the reclamation state. Supported fields in the filter are [state, appUserId, managedAppId]
  'orderBy': orderBy_example, // {{String}} Fields by which the results should be ordered. Supported fields in the orderBy are [state, managedAppId]
  'skipToken': skipToken_example, // {{String}} Used in pagination to point to the next set of records.
  'paginationLimit': paginationLimit_example // {{String}} Custom pagination limit to be used.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.reclamation_StateIndex(orgId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class reclamation_StateIndexExample
    {
        public void main()
        {


            var apiInstance = new ReclamationStateApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given Id.
            var filter = filter_example;  // String | The filter to query the reclamation state. Supported fields in the filter are [state, appUserId, managedAppId] (optional) 
            var orderBy = orderBy_example;  // String | Fields by which the results should be ordered. Supported fields in the orderBy are [state, managedAppId] (optional)  (default to state desc)
            var skipToken = skipToken_example;  // String | Used in pagination to point to the next set of records. (optional) 
            var paginationLimit = paginationLimit_example;  // String | Custom pagination limit to be used. (optional) 

            try
            {
                // List reclamation states.
                ReclamationStates result = apiInstance.reclamation_StateIndex(orgId, filter, orderBy, skipToken, paginationLimit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReclamationStateApi.reclamation_StateIndex: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiReclamationStateApi();
$orgId = orgId_example; // String | orgId identifies an organization by given Id.
$filter = filter_example; // String | The filter to query the reclamation state. Supported fields in the filter are [state, appUserId, managedAppId]
$orderBy = orderBy_example; // String | Fields by which the results should be ordered. Supported fields in the orderBy are [state, managedAppId]
$skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
$paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.

try {
    $result = $api_instance->reclamation_StateIndex($orgId, $filter, $orderBy, $skipToken, $paginationLimit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReclamationStateApi->reclamation_StateIndex: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReclamationStateApi;


my $api_instance = WWW::SwaggerClient::ReclamationStateApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given Id.
my $filter = filter_example; # String | The filter to query the reclamation state. Supported fields in the filter are [state, appUserId, managedAppId]
my $orderBy = orderBy_example; # String | Fields by which the results should be ordered. Supported fields in the orderBy are [state, managedAppId]
my $skipToken = skipToken_example; # String | Used in pagination to point to the next set of records.
my $paginationLimit = paginationLimit_example; # String | Custom pagination limit to be used.

eval { 
    my $result = $api_instance->reclamation_StateIndex(orgId => $orgId, filter => $filter, orderBy => $orderBy, skipToken => $skipToken, paginationLimit => $paginationLimit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReclamationStateApi->reclamation_StateIndex: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ReclamationStateApi()
orgId = orgId_example # String | orgId identifies an organization by given Id.
filter = filter_example # String | The filter to query the reclamation state. Supported fields in the filter are [state, appUserId, managedAppId] (optional)
orderBy = orderBy_example # String | Fields by which the results should be ordered. Supported fields in the orderBy are [state, managedAppId] (optional) (default to state desc)
skipToken = skipToken_example # String | Used in pagination to point to the next set of records. (optional)
paginationLimit = paginationLimit_example # String | Custom pagination limit to be used. (optional)

try: 
    # List reclamation states.
    api_response = api_instance.reclamation_state_index(orgId, filter=filter, orderBy=orderBy, skipToken=skipToken, paginationLimit=paginationLimit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReclamationStateApi->reclamation_StateIndex: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given Id.
Required
Query parameters
Name Description
filter
String
The filter to query the reclamation state. Supported fields in the filter are [state, appUserId, managedAppId]
orderBy
String
Fields by which the results should be ordered. Supported fields in the orderBy are [state, managedAppId]
skipToken
String
Used in pagination to point to the next set of records.
paginationLimit
String
Custom pagination limit to be used.

Responses

Status: 200 - OK response.

{"nextPage":"/orgs/1/reclamation-states?skipToken=b2NjdXJyZWQgZ3QgJzE5NzAtMDEtMDFUMDA6MDA6MDBaJyNvY2N1cnJlZCBkZXNjIzEjNTU2NDg5MDgz","values":[{"appUserId":"123","lastModified":"2018-05-16T16:31:52.1000Z","managedAppId":"123","reason":"Inactive Employee","state":"QUEUED"},{"appUserId":"123","lastModified":"2018-05-16T16:31:52.1000Z","managedAppId":"123","reason":"Inactive Employee","state":"QUEUED"}]}

Status: 400 - Bad Request response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

PerformOperations

Perform operations.

Runs operations to either reclaim immediately or notify users.


/saas/v1/orgs/{orgId}/reclamation-states

Usage and SDK Samples

curl -X PATCH\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
-H "Content-Type: application/json"\
"http://localhost:80/saas/v1/orgs/{orgId}/reclamation-states"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReclamationStateApi;

import java.io.File;
import java.util.*;

public class ReclamationStateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ReclamationStateApi apiInstance = new ReclamationStateApi();
        PerformOperationsRequestBody body = {
  "operations" : [ {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  }, {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  }, {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  } ]
}; // PerformOperationsRequestBody | 
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        try {
            array[ReclamationStateTransitionResult] result = apiInstance.reclamation_StatePerformOperations(body, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReclamationStateApi#reclamation_StatePerformOperations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReclamationStateApi;

public class ReclamationStateApiExample {

    public static void main(String[] args) {
        ReclamationStateApi apiInstance = new ReclamationStateApi();
        PerformOperationsRequestBody body = {
  "operations" : [ {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  }, {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  }, {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  } ]
}; // PerformOperationsRequestBody | 
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        try {
            array[ReclamationStateTransitionResult] result = apiInstance.reclamation_StatePerformOperations(body, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReclamationStateApi#reclamation_StatePerformOperations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
PerformOperationsRequestBody *body = {
  "operations" : [ {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  }, {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  }, {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  } ]
}; // 
String *orgId = orgId_example; // orgId identifies an organization by given ID.

ReclamationStateApi *apiInstance = [[ReclamationStateApi alloc] init];

// Perform operations.
[apiInstance reclamation_StatePerformOperationsWith:body
    orgId:orgId
              completionHandler: ^(array[ReclamationStateTransitionResult] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ReclamationStateApi()
var body = {
  "operations" : [ {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  }, {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  }, {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  } ]
}; // {{PerformOperationsRequestBody}} 
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.reclamation_StatePerformOperations(bodyorgId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class reclamation_StatePerformOperationsExample
    {
        public void main()
        {


            var apiInstance = new ReclamationStateApi();
            var body = new PerformOperationsRequestBody(); // PerformOperationsRequestBody | 
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.

            try
            {
                // Perform operations.
                array[ReclamationStateTransitionResult] result = apiInstance.reclamation_StatePerformOperations(body, orgId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReclamationStateApi.reclamation_StatePerformOperations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiReclamationStateApi();
$body = {
  "operations" : [ {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  }, {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  }, {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  } ]
}; // PerformOperationsRequestBody | 
$orgId = orgId_example; // String | orgId identifies an organization by given ID.

try {
    $result = $api_instance->reclamation_StatePerformOperations($body, $orgId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReclamationStateApi->reclamation_StatePerformOperations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReclamationStateApi;


my $api_instance = WWW::SwaggerClient::ReclamationStateApi->new();
my $body = WWW::SwaggerClient::Object::PerformOperationsRequestBody->new(); # PerformOperationsRequestBody | 
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.

eval { 
    my $result = $api_instance->reclamation_StatePerformOperations(body => $body, orgId => $orgId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReclamationStateApi->reclamation_StatePerformOperations: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ReclamationStateApi()
body = {
  "operations" : [ {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  }, {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  }, {
    "appUserIds" : [ "Delectus nihil.", "Quia assumenda voluptates ea nam eum repellat." ],
    "managedAppId" : "123",
    "operation" : "reclaim-immediately"
  } ]
} # PerformOperationsRequestBody | 
orgId = orgId_example # String | orgId identifies an organization by given ID.

try: 
    # Perform operations.
    api_response = api_instance.reclamation_state_perform_operations(body, orgId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReclamationStateApi->reclamation_StatePerformOperations: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK response.

[{"description":"Cannot change the State to OPPORTUNITY","reclamationState":{"appUserId":"123","lastModified":"2018-05-16T16:31:52.1000Z","managedAppId":"123","reason":"Inactive Employee","state":"QUEUED"},"successful":false},{"description":"Cannot change the State to OPPORTUNITY","reclamationState":{"appUserId":"123","lastModified":"2018-05-16T16:31:52.1000Z","managedAppId":"123","reason":"Inactive Employee","state":"QUEUED"},"successful":false}]

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Update

Update reclamation state for user.

Updates the reclamation state for the given managed app user ID.


/saas/v1/orgs/{orgId}/app-users/{appUserId}/reclamation-states

Usage and SDK Samples

curl -X PATCH\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
-H "Content-Type: application/json"\
"http://localhost:80/saas/v1/orgs/{orgId}/app-users/{appUserId}/reclamation-states"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReclamationStateApi;

import java.io.File;
import java.util.*;

public class ReclamationStateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ReclamationStateApi apiInstance = new ReclamationStateApi();
        UpdateRequestBody2 body = {
  "managedAppId" : "123",
  "reason" : "Inactive Employee",
  "state" : "COMPLETED"
}; // UpdateRequestBody2 | 
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String appUserId = appUserId_example; // String | ID of the user whose state will be updated.
        try {
            ReclamationStateTransitionResult result = apiInstance.reclamation_StateUpdate(body, orgId, appUserId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReclamationStateApi#reclamation_StateUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReclamationStateApi;

public class ReclamationStateApiExample {

    public static void main(String[] args) {
        ReclamationStateApi apiInstance = new ReclamationStateApi();
        UpdateRequestBody2 body = {
  "managedAppId" : "123",
  "reason" : "Inactive Employee",
  "state" : "COMPLETED"
}; // UpdateRequestBody2 | 
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        String appUserId = appUserId_example; // String | ID of the user whose state will be updated.
        try {
            ReclamationStateTransitionResult result = apiInstance.reclamation_StateUpdate(body, orgId, appUserId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReclamationStateApi#reclamation_StateUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
UpdateRequestBody2 *body = {
  "managedAppId" : "123",
  "reason" : "Inactive Employee",
  "state" : "COMPLETED"
}; // 
String *orgId = orgId_example; // orgId identifies an organization by given ID.
String *appUserId = appUserId_example; // ID of the user whose state will be updated.

ReclamationStateApi *apiInstance = [[ReclamationStateApi alloc] init];

// Update reclamation state for user.
[apiInstance reclamation_StateUpdateWith:body
    orgId:orgId
    appUserId:appUserId
              completionHandler: ^(ReclamationStateTransitionResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ReclamationStateApi()
var body = {
  "managedAppId" : "123",
  "reason" : "Inactive Employee",
  "state" : "COMPLETED"
}; // {{UpdateRequestBody2}} 
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.
var appUserId = appUserId_example; // {{String}} ID of the user whose state will be updated.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.reclamation_StateUpdate(bodyorgIdappUserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class reclamation_StateUpdateExample
    {
        public void main()
        {


            var apiInstance = new ReclamationStateApi();
            var body = new UpdateRequestBody2(); // UpdateRequestBody2 | 
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.
            var appUserId = appUserId_example;  // String | ID of the user whose state will be updated.

            try
            {
                // Update reclamation state for user.
                ReclamationStateTransitionResult result = apiInstance.reclamation_StateUpdate(body, orgId, appUserId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReclamationStateApi.reclamation_StateUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiReclamationStateApi();
$body = {
  "managedAppId" : "123",
  "reason" : "Inactive Employee",
  "state" : "COMPLETED"
}; // UpdateRequestBody2 | 
$orgId = orgId_example; // String | orgId identifies an organization by given ID.
$appUserId = appUserId_example; // String | ID of the user whose state will be updated.

try {
    $result = $api_instance->reclamation_StateUpdate($body, $orgId, $appUserId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReclamationStateApi->reclamation_StateUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReclamationStateApi;


my $api_instance = WWW::SwaggerClient::ReclamationStateApi->new();
my $body = WWW::SwaggerClient::Object::UpdateRequestBody2->new(); # UpdateRequestBody2 | 
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.
my $appUserId = appUserId_example; # String | ID of the user whose state will be updated.

eval { 
    my $result = $api_instance->reclamation_StateUpdate(body => $body, orgId => $orgId, appUserId => $appUserId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReclamationStateApi->reclamation_StateUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ReclamationStateApi()
body = {
  "managedAppId" : "123",
  "reason" : "Inactive Employee",
  "state" : "COMPLETED"
} # UpdateRequestBody2 | 
orgId = orgId_example # String | orgId identifies an organization by given ID.
appUserId = appUserId_example # String | ID of the user whose state will be updated.

try: 
    # Update reclamation state for user.
    api_response = api_instance.reclamation_state_update(body, orgId, appUserId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReclamationStateApi->reclamation_StateUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required
appUserId*
String
ID of the user whose state will be updated.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK response.

{"description":"Cannot change the State to OPPORTUNITY","reclamationState":{"appUserId":"123","lastModified":"2018-05-16T16:31:52.1000Z","managedAppId":"123","reason":"Inactive Employee","state":"QUEUED"},"successful":false}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

UpdateMany

Update reclamation state for users.

Updates the reclamation state for the given application users.


/saas/v1/orgs/{orgId}/reclamation-states

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
-H "Content-Type: application/json"\
"http://localhost:80/saas/v1/orgs/{orgId}/reclamation-states"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReclamationStateApi;

import java.io.File;
import java.util.*;

public class ReclamationStateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ReclamationStateApi apiInstance = new ReclamationStateApi();
        UpdateManyRequestBody body = {
  "states" : [ {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  }, {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  }, {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  } ]
}; // UpdateManyRequestBody | 
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        try {
            array[ReclamationStateTransitionResult] result = apiInstance.reclamation_StateUpdateMany(body, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReclamationStateApi#reclamation_StateUpdateMany");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReclamationStateApi;

public class ReclamationStateApiExample {

    public static void main(String[] args) {
        ReclamationStateApi apiInstance = new ReclamationStateApi();
        UpdateManyRequestBody body = {
  "states" : [ {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  }, {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  }, {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  } ]
}; // UpdateManyRequestBody | 
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        try {
            array[ReclamationStateTransitionResult] result = apiInstance.reclamation_StateUpdateMany(body, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReclamationStateApi#reclamation_StateUpdateMany");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
UpdateManyRequestBody *body = {
  "states" : [ {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  }, {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  }, {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  } ]
}; // 
String *orgId = orgId_example; // orgId identifies an organization by given ID.

ReclamationStateApi *apiInstance = [[ReclamationStateApi alloc] init];

// Update reclamation state for users.
[apiInstance reclamation_StateUpdateManyWith:body
    orgId:orgId
              completionHandler: ^(array[ReclamationStateTransitionResult] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.ReclamationStateApi()
var body = {
  "states" : [ {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  }, {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  }, {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  } ]
}; // {{UpdateManyRequestBody}} 
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.reclamation_StateUpdateMany(bodyorgId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class reclamation_StateUpdateManyExample
    {
        public void main()
        {


            var apiInstance = new ReclamationStateApi();
            var body = new UpdateManyRequestBody(); // UpdateManyRequestBody | 
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.

            try
            {
                // Update reclamation state for users.
                array[ReclamationStateTransitionResult] result = apiInstance.reclamation_StateUpdateMany(body, orgId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReclamationStateApi.reclamation_StateUpdateMany: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiReclamationStateApi();
$body = {
  "states" : [ {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  }, {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  }, {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  } ]
}; // UpdateManyRequestBody | 
$orgId = orgId_example; // String | orgId identifies an organization by given ID.

try {
    $result = $api_instance->reclamation_StateUpdateMany($body, $orgId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReclamationStateApi->reclamation_StateUpdateMany: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReclamationStateApi;


my $api_instance = WWW::SwaggerClient::ReclamationStateApi->new();
my $body = WWW::SwaggerClient::Object::UpdateManyRequestBody->new(); # UpdateManyRequestBody | 
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.

eval { 
    my $result = $api_instance->reclamation_StateUpdateMany(body => $body, orgId => $orgId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReclamationStateApi->reclamation_StateUpdateMany: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ReclamationStateApi()
body = {
  "states" : [ {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  }, {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  }, {
    "appUserId" : "123",
    "lastModified" : "2018-05-16T16:31:52.1000Z",
    "managedAppId" : "123",
    "reason" : "Inactive Employee",
    "state" : "QUEUED"
  } ]
} # UpdateManyRequestBody | 
orgId = orgId_example # String | orgId identifies an organization by given ID.

try: 
    # Update reclamation state for users.
    api_response = api_instance.reclamation_state_update_many(body, orgId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReclamationStateApi->reclamation_StateUpdateMany: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK response.

[{"description":"Cannot change the State to OPPORTUNITY","reclamationState":{"appUserId":"123","lastModified":"2018-05-16T16:31:52.1000Z","managedAppId":"123","reason":"Inactive Employee","state":"QUEUED"},"successful":false},{"description":"Cannot change the State to OPPORTUNITY","reclamationState":{"appUserId":"123","lastModified":"2018-05-16T16:31:52.1000Z","managedAppId":"123","reason":"Inactive Employee","state":"QUEUED"},"successful":false},{"description":"Cannot change the State to OPPORTUNITY","reclamationState":{"appUserId":"123","lastModified":"2018-05-16T16:31:52.1000Z","managedAppId":"123","reason":"Inactive Employee","state":"QUEUED"},"successful":false},{"description":"Cannot change the State to OPPORTUNITY","reclamationState":{"appUserId":"123","lastModified":"2018-05-16T16:31:52.1000Z","managedAppId":"123","reason":"Inactive Employee","state":"QUEUED"},"successful":false}]

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Saas Data

Create

Create SaaS data entry.

Resource to create a SaaS data entry in order to load data files.


/saas/v1/orgs/{orgId}/saas-data

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/vnd.goa.error"\
-H "Content-Type: application/json"\
"http://localhost:80/saas/v1/orgs/{orgId}/saas-data"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SaasDataApi;

import java.io.File;
import java.util.*;

public class SaasDataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        SaasDataApi apiInstance = new SaasDataApi();
        CreateRequestBody2 body = {
  "fileName" : "user-roster-1610923829.json"
}; // CreateRequestBody2 | 
        Long orgId = 789; // Long | organization ID
        try {
            apiInstance.saas_DataCreate(body, orgId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaasDataApi#saas_DataCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SaasDataApi;

public class SaasDataApiExample {

    public static void main(String[] args) {
        SaasDataApi apiInstance = new SaasDataApi();
        CreateRequestBody2 body = {
  "fileName" : "user-roster-1610923829.json"
}; // CreateRequestBody2 | 
        Long orgId = 789; // Long | organization ID
        try {
            apiInstance.saas_DataCreate(body, orgId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaasDataApi#saas_DataCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
CreateRequestBody2 *body = {
  "fileName" : "user-roster-1610923829.json"
}; // 
Long *orgId = 789; // organization ID

SaasDataApi *apiInstance = [[SaasDataApi alloc] init];

// Create SaaS data entry.
[apiInstance saas_DataCreateWith:body
    orgId:orgId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.SaasDataApi()
var body = {
  "fileName" : "user-roster-1610923829.json"
}; // {{CreateRequestBody2}} 
var orgId = 789; // {{Long}} organization ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.saas_DataCreate(bodyorgId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class saas_DataCreateExample
    {
        public void main()
        {


            var apiInstance = new SaasDataApi();
            var body = new CreateRequestBody2(); // CreateRequestBody2 | 
            var orgId = 789;  // Long | organization ID

            try
            {
                // Create SaaS data entry.
                apiInstance.saas_DataCreate(body, orgId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SaasDataApi.saas_DataCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiSaasDataApi();
$body = {
  "fileName" : "user-roster-1610923829.json"
}; // CreateRequestBody2 | 
$orgId = 789; // Long | organization ID

try {
    $api_instance->saas_DataCreate($body, $orgId);
} catch (Exception $e) {
    echo 'Exception when calling SaasDataApi->saas_DataCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SaasDataApi;


my $api_instance = WWW::SwaggerClient::SaasDataApi->new();
my $body = WWW::SwaggerClient::Object::CreateRequestBody2->new(); # CreateRequestBody2 | 
my $orgId = 789; # Long | organization ID

eval { 
    $api_instance->saas_DataCreate(body => $body, orgId => $orgId);
};
if ($@) {
    warn "Exception when calling SaasDataApi->saas_DataCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.SaasDataApi()
body = {
  "fileName" : "user-roster-1610923829.json"
} # CreateRequestBody2 | 
orgId = 789 # Long | organization ID

try: 
    # Create SaaS data entry.
    api_instance.saas_data_create(body, orgId)
except ApiException as e:
    print("Exception when calling SaasDataApi->saas_DataCreate: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
Long (int64)
organization ID
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created response.

Name Type Format Description
Location String /saas/v1/orgs/123/saas-data/7064d0d1-79fc-4aec-8190-bda87fa6de28 URL for the newly created upload job. Use this URL to call the 'upload' endpoint.

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Index

List SaaS data.

This endpoint retrieves a list of saas data.


/saas/v1/orgs/{orgId}/saas-data

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/saas-data?orderBy=&skipToken="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SaasDataApi;

import java.io.File;
import java.util.*;

public class SaasDataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        SaasDataApi apiInstance = new SaasDataApi();
        Long orgId = 789; // Long | The org that the SaaS data belongs to
        String orderBy = orderBy_example; // String | The order by to sort the import jobs. Supported fields in the orderBy are [createdAt, modifiedAt]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        try {
            SaasDataList result = apiInstance.saas_DataIndex(orgId, orderBy, skipToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaasDataApi#saas_DataIndex");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SaasDataApi;

public class SaasDataApiExample {

    public static void main(String[] args) {
        SaasDataApi apiInstance = new SaasDataApi();
        Long orgId = 789; // Long | The org that the SaaS data belongs to
        String orderBy = orderBy_example; // String | The order by to sort the import jobs. Supported fields in the orderBy are [createdAt, modifiedAt]
        String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
        try {
            SaasDataList result = apiInstance.saas_DataIndex(orgId, orderBy, skipToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaasDataApi#saas_DataIndex");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Long *orgId = 789; // The org that the SaaS data belongs to
String *orderBy = orderBy_example; // The order by to sort the import jobs. Supported fields in the orderBy are [createdAt, modifiedAt] (optional) (default to completedAt desc)
String *skipToken = skipToken_example; // Used in pagination to point to the next set of records. (optional)

SaasDataApi *apiInstance = [[SaasDataApi alloc] init];

// List SaaS data.
[apiInstance saas_DataIndexWith:orgId
    orderBy:orderBy
    skipToken:skipToken
              completionHandler: ^(SaasDataList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.SaasDataApi()
var orgId = 789; // {{Long}} The org that the SaaS data belongs to
var opts = { 
  'orderBy': orderBy_example, // {{String}} The order by to sort the import jobs. Supported fields in the orderBy are [createdAt, modifiedAt]
  'skipToken': skipToken_example // {{String}} Used in pagination to point to the next set of records.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saas_DataIndex(orgId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class saas_DataIndexExample
    {
        public void main()
        {


            var apiInstance = new SaasDataApi();
            var orgId = 789;  // Long | The org that the SaaS data belongs to
            var orderBy = orderBy_example;  // String | The order by to sort the import jobs. Supported fields in the orderBy are [createdAt, modifiedAt] (optional)  (default to completedAt desc)
            var skipToken = skipToken_example;  // String | Used in pagination to point to the next set of records. (optional) 

            try
            {
                // List SaaS data.
                SaasDataList result = apiInstance.saas_DataIndex(orgId, orderBy, skipToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SaasDataApi.saas_DataIndex: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiSaasDataApi();
$orgId = 789; // Long | The org that the SaaS data belongs to
$orderBy = orderBy_example; // String | The order by to sort the import jobs. Supported fields in the orderBy are [createdAt, modifiedAt]
$skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.

try {
    $result = $api_instance->saas_DataIndex($orgId, $orderBy, $skipToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SaasDataApi->saas_DataIndex: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SaasDataApi;


my $api_instance = WWW::SwaggerClient::SaasDataApi->new();
my $orgId = 789; # Long | The org that the SaaS data belongs to
my $orderBy = orderBy_example; # String | The order by to sort the import jobs. Supported fields in the orderBy are [createdAt, modifiedAt]
my $skipToken = skipToken_example; # String | Used in pagination to point to the next set of records.

eval { 
    my $result = $api_instance->saas_DataIndex(orgId => $orgId, orderBy => $orderBy, skipToken => $skipToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SaasDataApi->saas_DataIndex: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.SaasDataApi()
orgId = 789 # Long | The org that the SaaS data belongs to
orderBy = orderBy_example # String | The order by to sort the import jobs. Supported fields in the orderBy are [createdAt, modifiedAt] (optional) (default to completedAt desc)
skipToken = skipToken_example # String | Used in pagination to point to the next set of records. (optional)

try: 
    # List SaaS data.
    api_response = api_instance.saas_data_index(orgId, orderBy=orderBy, skipToken=skipToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SaasDataApi->saas_DataIndex: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
Long (int64)
The org that the SaaS data belongs to
Required
Query parameters
Name Description
orderBy
String
The order by to sort the import jobs. Supported fields in the orderBy are [createdAt, modifiedAt]
skipToken
String
Used in pagination to point to the next set of records.

Responses

Status: 200 - OK response.

{"count":20,"items":[{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"},{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"},{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"}]}

Status: 400 - Bad Request response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Show

Show SaaS data.

This endpoint retrieves a single SaaS data entry.


/saas/v1/orgs/{orgId}/saas-data/{id}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/saas-data/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SaasDataApi;

import java.io.File;
import java.util.*;

public class SaasDataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        SaasDataApi apiInstance = new SaasDataApi();
        Long orgId = 789; // Long | The org that the SaaS data belongs to
        String id = id_example; // String | 
        try {
            FlexeraFsmSaasdata result = apiInstance.saas_DataShow(orgId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaasDataApi#saas_DataShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SaasDataApi;

public class SaasDataApiExample {

    public static void main(String[] args) {
        SaasDataApi apiInstance = new SaasDataApi();
        Long orgId = 789; // Long | The org that the SaaS data belongs to
        String id = id_example; // String | 
        try {
            FlexeraFsmSaasdata result = apiInstance.saas_DataShow(orgId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaasDataApi#saas_DataShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Long *orgId = 789; // The org that the SaaS data belongs to
String *id = id_example; // 

SaasDataApi *apiInstance = [[SaasDataApi alloc] init];

// Show SaaS data.
[apiInstance saas_DataShowWith:orgId
    id:id
              completionHandler: ^(FlexeraFsmSaasdata output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.SaasDataApi()
var orgId = 789; // {{Long}} The org that the SaaS data belongs to
var id = id_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saas_DataShow(orgId, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class saas_DataShowExample
    {
        public void main()
        {


            var apiInstance = new SaasDataApi();
            var orgId = 789;  // Long | The org that the SaaS data belongs to
            var id = id_example;  // String | 

            try
            {
                // Show SaaS data.
                FlexeraFsmSaasdata result = apiInstance.saas_DataShow(orgId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SaasDataApi.saas_DataShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiSaasDataApi();
$orgId = 789; // Long | The org that the SaaS data belongs to
$id = id_example; // String | 

try {
    $result = $api_instance->saas_DataShow($orgId, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SaasDataApi->saas_DataShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SaasDataApi;


my $api_instance = WWW::SwaggerClient::SaasDataApi->new();
my $orgId = 789; # Long | The org that the SaaS data belongs to
my $id = id_example; # String | 

eval { 
    my $result = $api_instance->saas_DataShow(orgId => $orgId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SaasDataApi->saas_DataShow: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.SaasDataApi()
orgId = 789 # Long | The org that the SaaS data belongs to
id = id_example # String | 

try: 
    # Show SaaS data.
    api_response = api_instance.saas_data_show(orgId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SaasDataApi->saas_DataShow: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
Long (int64)
The org that the SaaS data belongs to
Required
id*
String
Required

Responses

Status: 200 - OK response.

{"checksum":"00236a2ae558018ed13b5222ef1bd977","contentEncoding":"gzip","contentType":"JSON","createdAt":"2018-05-16T16:31:52.1000Z","description":"December 2019 ApplicationUsage for Slack","id":"managed-app_1234_sept-2020.csv.gz","modifiedAt":"2018-05-16T16:31:52.1000Z","name":"users.gzip"}

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Upload

Upload data.

The upload action into a SaaS data entry. Once data is upload to the entity, this endpoint will not allow you to call this action again. The binary content of the file must be added to request Body.


/saas/v1/orgs/{orgId}/saas-data/{id}

Usage and SDK Samples

//for uploading plaintext jsonl file
curl -H "Authorization: Bearer [[accessToken]]" -H "Accept: application/vnd.goa.error" -H "Content-Type: application/json" -H "Checksum: [[md5-checksum]]" -X PATCH --data-binary "@/jsonl/file/path/to/be/uploaded" "http://localhost:80/saas/v1/orgs/{orgId}/saas-data/{id}"

//for uploading gzip file
curl -H "Authorization: Bearer [[accessToken]]" -H "Accept: application/vnd.goa.error" -H "Content-Encoding: gzip" -H "Content-Type: application/json" -H "Checksum: [[md5-checksum]]" -X PATCH --data-binary "@/gzip/file/path/to/be/uploaded" "http://localhost:80/saas/v1/orgs/{orgId}/saas-data/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SaasDataApi;

import java.io.File;
import java.util.*;

public class SaasDataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        SaasDataApi apiInstance = new SaasDataApi();
        Integer orgId = 56; // Integer | The org this file belongs to
        String id = id_example; // String | The identifier returned by create endpoint as part of the Url.
        String contentType = contentType_example; // String | The only accepted Content-Type is application/json. This will be expanded on in the future.
        String checksum = checksum_example; // String | The lowercase hex-encoded MD5 checksum value of the file being uploaded.
        String contentEncoding = contentEncoding_example; // String | When present, its value indicates which encodings were applied to the entity-body. Generally, it is advised the file be gzip compressed. If this is not specified, it will be assumed the file is not compressed. Use 'gzip' as contentEncoding to represent the gzip compressed file.
        String description = description_example; // String | A human readable value for reference.
        try {
            apiInstance.saas_DataUpload(orgId, id, contentType, checksum, contentEncoding, description);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaasDataApi#saas_DataUpload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SaasDataApi;

public class SaasDataApiExample {

    public static void main(String[] args) {
        SaasDataApi apiInstance = new SaasDataApi();
        Integer orgId = 56; // Integer | The org this file belongs to
        String id = id_example; // String | The identifier returned by create endpoint as part of the Url.
        String contentType = contentType_example; // String | The only accepted Content-Type is application/json. This will be expanded on in the future.
        String checksum = checksum_example; // String | The lowercase hex-encoded MD5 checksum value of the file being uploaded.
        String contentEncoding = contentEncoding_example; // String | When present, its value indicates which encodings were applied to the entity-body. Generally, it is advised the file be gzip compressed. If this is not specified, it will be assumed the file is not compressed. Use 'gzip' as contentEncoding to represent the gzip compressed file.
        String description = description_example; // String | A human readable value for reference.
        try {
            apiInstance.saas_DataUpload(orgId, id, contentType, checksum, contentEncoding, description);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaasDataApi#saas_DataUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *orgId = 56; // The org this file belongs to
String *id = id_example; // The identifier returned by create endpoint as part of the Url.
String *contentType = contentType_example; // The only accepted Content-Type is application/json. This will be expanded on in the future.
String *checksum = checksum_example; // The lowercase hex-encoded MD5 checksum value of the file being uploaded.
String *contentEncoding = contentEncoding_example; // When present, its value indicates which encodings were applied to the entity-body. Generally, it is advised the file be gzip compressed. If this is not specified, it will be assumed the file is not compressed. Use 'gzip' as contentEncoding to represent the gzip compressed file. (optional)
String *description = description_example; // A human readable value for reference. (optional)

SaasDataApi *apiInstance = [[SaasDataApi alloc] init];

// Upload data.
[apiInstance saas_DataUploadWith:orgId
    id:id
    contentType:contentType
    checksum:checksum
    contentEncoding:contentEncoding
    description:description
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.SaasDataApi()
var orgId = 56; // {{Integer}} The org this file belongs to
var id = id_example; // {{String}} The identifier returned by create endpoint as part of the Url.
var contentType = contentType_example; // {{String}} The only accepted Content-Type is application/json. This will be expanded on in the future.
var checksum = checksum_example; // {{String}} The lowercase hex-encoded MD5 checksum value of the file being uploaded.
var opts = { 
  'contentEncoding': contentEncoding_example, // {{String}} When present, its value indicates which encodings were applied to the entity-body. Generally, it is advised the file be gzip compressed. If this is not specified, it will be assumed the file is not compressed. Use 'gzip' as contentEncoding to represent the gzip compressed file.
  'description': description_example // {{String}} A human readable value for reference.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.saas_DataUpload(orgId, id, contentType, checksum, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class saas_DataUploadExample
    {
        public void main()
        {


            var apiInstance = new SaasDataApi();
            var orgId = 56;  // Integer | The org this file belongs to
            var id = id_example;  // String | The identifier returned by create endpoint as part of the Url.
            var contentType = contentType_example;  // String | The only accepted Content-Type is application/json. This will be expanded on in the future.
            var checksum = checksum_example;  // String | The lowercase hex-encoded MD5 checksum value of the file being uploaded.
            var contentEncoding = contentEncoding_example;  // String | When present, its value indicates which encodings were applied to the entity-body. Generally, it is advised the file be gzip compressed. If this is not specified, it will be assumed the file is not compressed. Use 'gzip' as contentEncoding to represent the gzip compressed file. (optional) 
            var description = description_example;  // String | A human readable value for reference. (optional) 

            try
            {
                // Upload data.
                apiInstance.saas_DataUpload(orgId, id, contentType, checksum, contentEncoding, description);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SaasDataApi.saas_DataUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiSaasDataApi();
$orgId = 56; // Integer | The org this file belongs to
$id = id_example; // String | The identifier returned by create endpoint as part of the Url.
$contentType = contentType_example; // String | The only accepted Content-Type is application/json. This will be expanded on in the future.
$checksum = checksum_example; // String | The lowercase hex-encoded MD5 checksum value of the file being uploaded.
$contentEncoding = contentEncoding_example; // String | When present, its value indicates which encodings were applied to the entity-body. Generally, it is advised the file be gzip compressed. If this is not specified, it will be assumed the file is not compressed. Use 'gzip' as contentEncoding to represent the gzip compressed file.
$description = description_example; // String | A human readable value for reference.

try {
    $api_instance->saas_DataUpload($orgId, $id, $contentType, $checksum, $contentEncoding, $description);
} catch (Exception $e) {
    echo 'Exception when calling SaasDataApi->saas_DataUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SaasDataApi;


my $api_instance = WWW::SwaggerClient::SaasDataApi->new();
my $orgId = 56; # Integer | The org this file belongs to
my $id = id_example; # String | The identifier returned by create endpoint as part of the Url.
my $contentType = contentType_example; # String | The only accepted Content-Type is application/json. This will be expanded on in the future.
my $checksum = checksum_example; # String | The lowercase hex-encoded MD5 checksum value of the file being uploaded.
my $contentEncoding = contentEncoding_example; # String | When present, its value indicates which encodings were applied to the entity-body. Generally, it is advised the file be gzip compressed. If this is not specified, it will be assumed the file is not compressed. Use 'gzip' as contentEncoding to represent the gzip compressed file.
my $description = description_example; # String | A human readable value for reference.

eval { 
    $api_instance->saas_DataUpload(orgId => $orgId, id => $id, contentType => $contentType, checksum => $checksum, contentEncoding => $contentEncoding, description => $description);
};
if ($@) {
    warn "Exception when calling SaasDataApi->saas_DataUpload: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.SaasDataApi()
orgId = 56 # Integer | The org this file belongs to
id = id_example # String | The identifier returned by create endpoint as part of the Url.
contentType = contentType_example # String | The only accepted Content-Type is application/json. This will be expanded on in the future.
checksum = checksum_example # String | The lowercase hex-encoded MD5 checksum value of the file being uploaded.
contentEncoding = contentEncoding_example # String | When present, its value indicates which encodings were applied to the entity-body. Generally, it is advised the file be gzip compressed. If this is not specified, it will be assumed the file is not compressed. Use 'gzip' as contentEncoding to represent the gzip compressed file. (optional)
description = description_example # String | A human readable value for reference. (optional)

try: 
    # Upload data.
    api_instance.saas_data_upload(orgId, id, contentType, checksum, contentEncoding=contentEncoding, description=description)
except ApiException as e:
    print("Exception when calling SaasDataApi->saas_DataUpload: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
Integer
The org this file belongs to
Required
id*
String
The identifier returned by create endpoint as part of the Url.
Required
Header parameters
Name Description
Content-Type*
String
The only accepted Content-Type is application/json. This will be expanded on in the future.
Required
Content-Encoding
String
When present, its value indicates which encodings were applied to the entity-body. Generally, it is advised the file be gzip compressed. If this is not specified, it will be assumed the file is not compressed. Use 'gzip' as contentEncoding to represent the gzip compressed file.
Checksum*
String
The lowercase hex-encoded MD5 checksum value of the file being uploaded.
Required
Description
String
A human readable value for reference.

Responses

Status: 204 - No Content response.

Status: 404 - Not Found response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 422 - Unprocessable Entity response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 423 - Locked response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Workspace

Show

Show workspace URL.

Retrieves the workspace URL created for a capability for an organization identified by orgId.


/saas/v1/orgs/{orgId}/workspaces

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/workspaces"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkspaceApi;

import java.io.File;
import java.util.*;

public class WorkspaceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        WorkspaceApi apiInstance = new WorkspaceApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        try {
            Workspace result = apiInstance.workspaceShow(orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkspaceApi#workspaceShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkspaceApi;

public class WorkspaceApiExample {

    public static void main(String[] args) {
        WorkspaceApi apiInstance = new WorkspaceApi();
        String orgId = orgId_example; // String | orgId identifies an organization by given ID.
        try {
            Workspace result = apiInstance.workspaceShow(orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkspaceApi#workspaceShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given ID.

WorkspaceApi *apiInstance = [[WorkspaceApi alloc] init];

// Show workspace URL.
[apiInstance workspaceShowWith:orgId
              completionHandler: ^(Workspace output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;


var api = new SaaSManagementFrontService.WorkspaceApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.workspaceShow(orgId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class workspaceShowExample
    {
        public void main()
        {


            var apiInstance = new WorkspaceApi();
            var orgId = orgId_example;  // String | orgId identifies an organization by given ID.

            try
            {
                // Show workspace URL.
                Workspace result = apiInstance.workspaceShow(orgId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkspaceApi.workspaceShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiWorkspaceApi();
$orgId = orgId_example; // String | orgId identifies an organization by given ID.

try {
    $result = $api_instance->workspaceShow($orgId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkspaceApi->workspaceShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkspaceApi;


my $api_instance = WWW::SwaggerClient::WorkspaceApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given ID.

eval { 
    my $result = $api_instance->workspaceShow(orgId => $orgId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkspaceApi->workspaceShow: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.WorkspaceApi()
orgId = orgId_example # String | orgId identifies an organization by given ID.

try: 
    # Show workspace URL.
    api_response = api_instance.workspace_show(orgId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkspaceApi->workspaceShow: %s\n" % e)

Parameters

Path parameters
Name Description
orgId*
String
orgId identifies an organization by given ID.
Required

Responses

Status: 200 - OK response.

{"workspaceURI":"/gdc/projects/xroz76a7hat8xtq50w4qwb9p199sjbt9"}

Status: 403 - Forbidden response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}

Status: 500 - Internal Server Error response.

{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}