### Get all teamsites (Python Example) Source: https://developer.seismic.com/seismicsoftware/reference/teamsites Python script to get a list of all teamsites using the 'requests' library. It performs a GET request to the API endpoint and includes the 'accept: application/json' header. Ensure you have the 'requests' library installed (`pip install requests`). ```python import requests url = "https://api.seismic.com/integration/v2/teamsites" headers = { "accept": "application/json" # Add your authentication headers here # "Authorization": "Bearer YOUR_ACCESS_TOKEN" } try: response = requests.get(url, headers=headers) response.raise_for_status() # Raise an exception for bad status codes (4xx or 5xx) teamsites = response.json() print(teamsites) except requests.exceptions.RequestException as e: print(f"Error fetching teamsites: {e}") ``` -------------------------------- ### POST /programs Source: https://developer.seismic.com/seismicsoftware/reference/create-program-template Creates a new program with specified configurations. This includes setting creation dates, associating content views, defining task generation rules, and assigning tasks. ```APIDOC ## POST /programs ### Description Creates a new program with specified configurations. This includes setting creation dates, associating content views, defining task generation rules, and assigning tasks. ### Method POST ### Endpoint /programs ### Parameters #### Request Body - **scheduledCreationDate** (string) - Optional - The dates to create the program. - **contentViewId** (string) - Optional - The content view id to create tasks for each content in the view. - **contentViewTeamSiteId** (string) - Optional - The content view TeamSite id to create tasks for each content in the view. - **generateTaskPerContent** (boolean) - Optional - If true, a task will be created for each content in the content view. - **assigneeType** (string) - Optional - The assignee type for the task. Can be content owner, program owner, user, and unassigned. - **assignedUserId** (string) - Optional - The user id to assign the task to. Only used when AssigneeType is user. - **inheritTaskNameFrom** (string) - Optional - The task name to inherit from. Can be content name and user specified task name. - **userSpecifiedTaskName** (string) - Optional - The task name to use for all auto created tasks for each content. Only used when InheritTaskNameFrom is user specified task name. ### Request Example ```json { "scheduledCreationDate": "2023-10-27T10:00:00Z", "contentViewId": "cv_123", "contentViewTeamSiteId": "ts_456", "generateTaskPerContent": true, "assigneeType": "contentOwner", "inheritTaskNameFrom": "contentName" } ``` ### Response #### Success Response (200) - **programId** (string) - The ID of the newly created program. - **message** (string) - A confirmation message. #### Response Example ```json { "programId": "prog_789", "message": "Program created successfully." } ``` ``` -------------------------------- ### Get Comments on an Item (PHP) Source: https://developer.seismic.com/seismicsoftware/reference/workspace-comments A PHP example for retrieving item comments via the Seismic API using Guzzle HTTP client. This code sends a GET request and processes the JSON response. Ensure Guzzle is installed via Composer. ```PHP request('GET', 'https://api.seismic.com/integration/v2/workspace/spaces/{spaceId}/items/{workspaceContentId}/comments', [ 'query' => [ 'offset' => '10', 'limit' => '40', ], 'headers' => [ 'accept' => 'application/json', ], ]); echo $response->getBody(); } catch (GuzzleHttp\Exception\GuzzleException $e) { echo 'Error: ' . $e->getMessage(); } ?> ``` -------------------------------- ### POST /v2/spaces/{spaceId}/programs/predefinedtemplates/{predefinedTemplateId}/apply Source: https://developer.seismic.com/seismicsoftware/reference/apply-predefined-program-template Apply a predefined program template to create a new program. This endpoint allows you to quickly set up a program based on an existing template, providing optional details like title, description, dates, and manager. ```APIDOC ## POST /v2/spaces/{spaceId}/programs/predefinedtemplates/{predefinedTemplateId}/apply ### Description Create a program with a predefined template. You can optionally provide a title, description, planned start and end dates, duration, manager ID, and custom properties. ### Method POST ### Endpoint /v2/spaces/{spaceId}/programs/predefinedtemplates/{predefinedTemplateId}/apply ### Parameters #### Path Parameters - **spaceId** (string) - Required - Space ID - **predefinedTemplateId** (string) - Required - Shortened id/guid of the predefined template to be applied #### Request Body - **title** (string) - Optional - Title of program - **description** (string) - Optional - Description of program - **plannedStartDate** (string) - Optional - Planned start date (format: date-time) - **plannedEndDate** (string) - Optional - Planned end date (format: date-time) - **plannedDuration** (integer) - Optional - Planned duration in days - **managerId** (string) - Optional - User ID of manager - **customProperties** (array) - Optional - Custom properties for the program ### Request Example ```json { "title": "My New Program", "description": "This is a program created from a template.", "plannedStartDate": "2023-10-27T10:00:00Z", "plannedEndDate": "2023-11-27T10:00:00Z", "managerId": "user123" } ``` ### Response #### Success Response (201) - **id** (string) - The unique identifier for the created program. - **title** (string) - The title of the program. - **description** (string) - The description of the program. - **spaceId** (string) - The ID of the space the program belongs to. - **status** (string) - The current status of the program. - **createdAt** (string) - The date and time the program was created (format: date-time). - **updatedAt** (string) - The date and time the program was last updated (format: date-time). - **plannedStartDate** (string) - The planned start date of the program (format: date-time). - **plannedEndDate** (string) - The planned end date of the program (format: date-time). - **plannedDuration** (integer) - The planned duration of the program in days. - **manager** (object) - Information about the program manager. - **id** (string) - The user ID of the manager. - **name** (string) - The name of the manager. - **customProperties** (array) - An array of custom properties associated with the program. #### Response Example ```json { "id": "prog_abc123", "title": "My New Program", "description": "This is a program created from a template.", "spaceId": "space_xyz789", "status": "Active", "createdAt": "2023-10-27T10:00:00Z", "updatedAt": "2023-10-27T10:05:00Z", "plannedStartDate": "2023-10-27T10:00:00Z", "plannedEndDate": "2023-11-27T10:00:00Z", "plannedDuration": 30, "manager": { "id": "user123", "name": "Jane Doe" }, "customProperties": [] } ``` #### Error Response (400, 401, 500) - **errorCode** (string) - A code indicating the type of error. - **message** (string) - A detailed message explaining the error. - **details** (string) - Additional details about the error. #### Error Response Example ```json { "errorCode": "INVALID_INPUT", "message": "The provided predefinedTemplateId is invalid.", "details": "Ensure the template ID exists and is accessible." } ``` ``` -------------------------------- ### POST /websites/developer_seismic_seismicsoftware_reference/programs Source: https://developer.seismic.com/seismicsoftware/reference/apply-program-template Creates a new program from a specified program template and returns a list of asynchronous action IDs for tracking the creation process. ```APIDOC ## POST /websites/developer_seismic_seismicsoftware_reference/programs ### Description Creates and returns a program from a program template. Once the program is created, a list of async action IDs is returned. This can be used via the Async Action endpoint to determine progress of the creation action. ### Method POST ### Endpoint /websites/developer_seismic_seismicsoftware_reference/programs ### Parameters #### Query Parameters - **template_id** (string) - Required - The ID of the program template to apply. ### Request Body This endpoint does not require a request body. ### Response #### Success Response (201 Created) - **program_id** (string) - The ID of the newly created program. - **async_action_ids** (array) - A list of asynchronous action IDs associated with the program creation. - **async_action_id** (string) - An ID for an asynchronous action. #### Response Example ```json { "program_id": "prog_12345abc", "async_action_ids": [ "action_abc123", "action_def456" ] } ``` ``` -------------------------------- ### Get Answers from Seismic API (Node.js) Source: https://developer.seismic.com/seismicsoftware/reference/learning This example shows how to fetch answer data from the Seismic API using Node.js. It makes a GET request to the /reporting/v2/answers endpoint and processes the JSON response. Ensure you have an HTTP client library like 'axios' installed. ```javascript const axios = require('axios'); const getAnswers = async () => { try { const response = await axios.get('https://api.seismic.com/reporting/v2/answers', { params: { limit: 1 }, headers: { 'Accept': 'application/json' } }); console.log(response.data); return response.data; } catch (error) { console.error('Error fetching answers:', error); } }; getAnswers(); ``` -------------------------------- ### GET /websites/developer_seismic_seismicsoftware_reference/guided-assembly/inputs Source: https://developer.seismic.com/seismicsoftware/reference/queryguidedassemblyinputlist Retrieves a list of inputs required for a guided assembly. This is useful for understanding what information needs to be provided before starting or continuing an assembly. ```APIDOC ## GET /websites/developer_seismic_seismicsoftware_reference/guided-assembly/inputs ### Description Retrieves a list of inputs required for a guided assembly. This is useful for understanding what information needs to be provided before starting or continuing an assembly. ### Method GET ### Endpoint /websites/developer_seismic_seismicsoftware_reference/guided-assembly/inputs ### Parameters #### Query Parameters *None explicitly defined in the provided OpenAPI snippet.* ### Response #### Success Response (200) - **GetGuidedAssemblyInputListResponse** (object) - Contains the list of guided assembly inputs. #### Error Response (401) - **ProblemDetails** (object) - Unauthorized access. #### Error Response (404) - **ProblemDetails** (object) - The requested resource was not found. #### Error Response (500) - **No specific response body schema defined in the provided OpenAPI snippet for server error.** ``` -------------------------------- ### POST /websites/developer_seismic_seismicsoftware_reference Source: https://developer.seismic.com/seismicsoftware/reference/make-program-template Creates a program template from an existing program. The returned async action IDs can be used to monitor the creation progress. ```APIDOC ## POST /websites/developer_seismic_seismicsoftware_reference ### Description Creates a program template from an existing program. This template can subsequently be used to create new programs via the `apply` template endpoint. Upon successful creation, a list of async action IDs is returned, which can be utilized with the Async Action endpoint to track the progress of the creation action. ### Method POST ### Endpoint /websites/developer_seismic_seismicsoftware_reference ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **program_id** (string) - Required - The ID of the existing program from which to create the template. ### Request Example ```json { "program_id": "existing_program_123" } ``` ### Response #### Success Response (200) - **async_action_ids** (array[string]) - A list of IDs for asynchronous actions related to the template creation. #### Response Example ```json { "async_action_ids": [ "async_action_abc", "async_action_def" ] } ``` ``` -------------------------------- ### POST /programs Source: https://developer.seismic.com/seismicsoftware/reference/make-program-template Creates a new program with specified scheduling, content view, and task assignment settings. ```APIDOC ## POST /programs ### Description Creates a new program with specified scheduling, content view, and task assignment settings. ### Method POST ### Endpoint /programs ### Parameters #### Request Body - **name** (string) - Required - The name of the program. - **description** (string) - Optional - A description for the program. - **ownerId** (string) - Required - The ID of the program owner. - **frequency** (string) - Required - The frequency of program creation. Options: "daily", "weekly", "monthly", "yearly". - **dayOfTheMonth** (integer) - Optional - The day of the month to create program monthly or yearly. 1 means the first day of the month, 31 means the last day of the month. - **dayOfTheWeek** (integer) - Optional - The day of the week to create program weekly. 0 means Sunday, 6 means Saturday. - **scheduledCreationDate** (array of strings) - Optional - The dates to create the program. Format: date-time. - **contentViewId** (string) - Optional - The content view id to create tasks for each content in the view. - **contentViewTeamSiteId** (string) - Optional - The content view TeamSite id to create tasks for each content in the view. - **generateTaskPerContent** (boolean) - Required - If true, a task will be created for each content in the content view. - **assigneeType** (string) - Optional - The assignee type for the task. Options: "contentOwner", "programOwner", "user", "unassigned". - **assignedUserId** (string) - Optional - The user id to assign the task to. Only used when AssigneeType is user. - **inheritTaskNameFrom** (string) - Optional - The task name to inherit from. Options: "contentName", "userSpecified". - **userSpecifiedTaskName** (string) - Optional - The task name to use for all auto created tasks for each content. Only used when InheritTaskNameFrom is user specified task name. ### Request Example ```json { "name": "Example Program", "description": "This is an example program.", "ownerId": "user-123", "frequency": "weekly", "dayOfTheWeek": 1, "generateTaskPerContent": true, "assigneeType": "contentOwner", "inheritTaskNameFrom": "contentName" } ``` ### Response #### Success Response (200) - **id** (string) - The unique identifier of the created program. - **name** (string) - The name of the program. - **description** (string) - The description of the program. - **ownerId** (string) - The ID of the program owner. - **frequency** (string) - The frequency of program creation. - **dayOfTheMonth** (integer) - The day of the month for creation (if applicable). - **dayOfTheWeek** (integer) - The day of the week for creation (if applicable). - **scheduledCreationDate** (array of strings) - The scheduled dates for creation. - **contentViewId** (string) - The content view ID used for task creation. - **contentViewTeamSiteId** (string) - The content view TeamSite ID used for task creation. - **generateTaskPerContent** (boolean) - Indicates if tasks are generated per content. - **assigneeType** (string) - The type of assignee for tasks. - **assignedUserId** (string) - The user ID assigned to tasks. - **inheritTaskNameFrom** (string) - How task names are inherited. - **userSpecifiedTaskName** (string) - The user-specified task name. #### Response Example ```json { "id": "prog-abcde", "name": "Example Program", "description": "This is an example program.", "ownerId": "user-123", "frequency": "weekly", "dayOfTheWeek": 1, "scheduledCreationDate": [], "contentViewId": null, "contentViewTeamSiteId": null, "generateTaskPerContent": true, "assigneeType": "contentOwner", "assignedUserId": null, "inheritTaskNameFrom": "contentName", "userSpecifiedTaskName": null } ``` ``` -------------------------------- ### Get Token using Client Credentials (Node.js) Source: https://developer.seismic.com/seismicsoftware/reference/sgdgsdfsdf This Node.js example shows how to obtain an access token using client credentials. It utilizes the 'axios' library to make a POST request to the token endpoint with the required form data. Ensure you have 'axios' installed (`npm install axios`). ```javascript const axios = require('axios'); async function getToken() { const tenant = 'your_tenant_id'; const clientId = 'your_client_id'; const clientSecret = 'your_client_secret'; const userId = 'your_user_id'; const scopes = 'auth_management auth_view'; const url = `https://auth.seismic.com/tenants/${tenant}/connect/token`; const data = new URLSearchParams(); data.append('grant_type', 'delegation'); data.append('client_id', clientId); data.append('client_secret', clientSecret); data.append('user_id', userId); data.append('scope', scopes); try { const response = await axios.post(url, data, { headers: { 'content-type': 'application/x-www-form-urlencoded', 'accept': 'application/json' } }); console.log('Token received:', response.data); return response.data; } catch (error) { console.error('Error getting token:', error.response ? error.response.data : error.message); throw error; } } getToken(); ``` -------------------------------- ### GET /websites/developer_seismic_seismicsoftware_reference/library_instructions Source: https://developer.seismic.com/seismicsoftware/reference/seismiclibraryinstructionsgetinstructionsonanitem Retrieves a list of library instructions for a given item. Supports pagination and count. ```APIDOC ## GET /websites/developer_seismic_seismicsoftware_reference/library_instructions ### Description Retrieves a paginated list of library instructions for a specific item. This endpoint is useful for fetching instructional content related to a particular asset or feature within the Seismic platform. ### Method GET ### Endpoint `/websites/developer_seismic_seismicsoftware_reference/library_instructions` ### Parameters #### Query Parameters - **limit** (number) - Optional - The maximum number of entries to return per page. - **offset** (number) - Optional - The number of entries to skip before starting to collect the result set. ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **entries** (array) - An array of instruction objects, each containing id, type, title, and text. - **totalCount** (number) - The total number of instructions available. - **limit** (number) - The limit set for the current response page. - **offset** (number) - The offset applied for the current response page. #### Response Example ```json { "entries": [ { "id": "a6766970-f0ef-4549-ac12-75747d5d47b3", "type": "text", "title": "test", "text": "
test
" }, { "id": "5459de36-8dd9-465f-bbdd-6c7c72b0b420", "type": "text", "title": "ATTENTION", "text": "Before sharing any documentation with your clients please ensure the fund / strategy is registered for sale in your market. You can check the country registration matrix
" } ], "totalCount": 4, "limit": 50, "offset": 0 } ``` ### Security - **JWTBearerToken**: A JWT Bearer token in the Authorization header identifying the Seismic user making the request. ``` -------------------------------- ### Get all teamsites (Node.js Example) Source: https://developer.seismic.com/seismicsoftware/reference/teamsites Example of fetching all teamsites using Node.js. This code snippet makes a GET request to the Seismic API endpoint. Ensure you have the necessary authentication headers configured. ```javascript // Example for Node.js // Requires 'axios' or built-in 'fetch' with appropriate configuration async function getTeamsites() { const url = 'https://api.seismic.com/integration/v2/teamsites'; const headers = { 'accept': 'application/json', // Add your authentication headers here // 'Authorization': 'Bearer YOUR_ACCESS_TOKEN' }; try { const response = await fetch(url, { method: 'GET', headers: headers }); if (!response.ok) { throw new Error(`HTTP error! status: ${response.status}`); } const data = await response.json(); console.log(data); return data; } catch (error) { console.error('Error fetching teamsites:', error); } } getTeamsites(); ``` -------------------------------- ### JSON Example of Content Recommendations and Objections Source: https://developer.seismic.com/seismicsoftware/reference/getpostmeetingoverview This JSON snippet illustrates how content recommendations and objections are structured within the Seismic software. It includes details about recommended files and specific concerns raised by users. ```json { "contentRecommendations": [ { "contentProfileId": "00000000-0000-0000-0000-000000000000", "quickAccessPath": null, "libraryContent": { "teamsiteId": "1", "id": "150d2ca1-e877-4d74-bfa3-e08f3458859e", "versionId": "0fa1ac89-cbdc-4b9e-930b-bc6e347c12e5" }, "repository": "doccenter", "type": "file", "name": "Sprint-12-Demo-v2222" }, { "contentProfileId": "00000000-0000-0000-0000-000000000000", "quickAccessPath": null, "libraryContent": { "teamsiteId": "1", "id": "a12913cc-d665-4606-adb0-0489538874eb", "versionId": "7d618f9e-bbf0-4ded-8ce3-51c86d75a1fe" }, "repository": "doccenter", "type": "file", "name": "Sprint-12-Demo-v333 - Copy" } ], "objections": [ { "text": "Jims Sun has concerns about the agreement on the extension and point to URL" } ] } ``` -------------------------------- ### Get all teamsites (PHP Example) Source: https://developer.seismic.com/seismicsoftware/reference/teamsites PHP code example for fetching teamsites. This uses cURL to send a GET request to the Seismic API endpoint, including the necessary 'accept' header for JSON responses. ```php ``` -------------------------------- ### Retrieve Channel Posts - Python Example Source: https://developer.seismic.com/seismicsoftware/reference/post This Python script retrieves posts from a Seismic channel using the `requests` library. It sends a GET request with an 'accept: application/json' header. Ensure you have the library installed and handle authentication and error conditions appropriately. ```python import requests url = "https://api.seismic.com/channel/v1/channels/channelId/posts" headers = { "accept": "application/json" } response = requests.get(url, headers=headers) print(response.text) ``` -------------------------------- ### Program Data Example (CSV) Source: https://developer.seismic.com/seismicsoftware/reference/reporting-programsget Provides an example of program data formatted as a CSV (Comma Separated Values) file. This format is commonly used for data import and export, offering a simple, tabular representation of program details. ```csv "id": "74b70bb8-8802-a1fd-f201-890375a60c8f", "title": "test title", "description": "test description", "createdAt": "2026-01-01T00:00:00.000Z", "createdBy": "57889934-37f5-0314-0689-8d54d4b970dc", "createdByUsername": "test createdByUsername", "systemModifiedAt": "2026-01-01T00:00:00.000Z", "userModifiedAt": "2026-01-01T00:00:00.000Z", "modifiedBy": "c83cd391-495e-5939-8a99-da31359e09c4", "modifiedByUsername": "test modifiedByUsername", "programManagerId": "1b821069-4cba-f234-3ca4-ed5412e4a347", "programManagerUsername": "test programManagerUsername", "plannedStartDate": "2026-01-01T00:00:00.000Z", "plannedEndDate": "2026-01-01T00:00:00.000Z", "plannedDurationDays": 1, "actualStartDate": "2026-01-01T00:00:00.000Z", "actualEndDate": "2026-01-01T00:00:00.000Z", "actualDurationDays": 1, "isOverdue": true, "templateId": "1fa30032-5dc0-e9a4-d5a0-465c36822e2f", "copyFromId": "0cb4c41e-eaae-82fe-2e9b-2eb955c3a6eb", "creationMethod": "New", "isDeleted": true, "deletedAt": "2026-01-01T00:00:00.000Z", "shortId": "b57ad6cd-ccb1-4e97-0eaf-e3571976fba9", "programAudience": "test programAudience", "programArchived": true, "programLaunchDate": "2026-01-01T00:00:00.000Z", "programOnboardingGroup": "test programOnboardingGroup", "programOutcomeKpiFirst": "test programOutcomeKpiFirst", "programOutcomeKpiSecond": "test programOutcomeKpiSecond", "programOutcomeKpiThird": "test programOutcomeKpiThird", "programType": "test programType", "programTopics": "test programTopics", "programTrackers": "test programTrackers" ``` -------------------------------- ### Get Ai Activity Data (Node.js) Source: https://developer.seismic.com/seismicsoftware/reference/ai This example shows how to fetch AI activity data using Node.js. It constructs the API request, sets headers, and handles the JSON response. Ensure you have the necessary libraries (e.g., 'axios' or 'node-fetch') installed. ```javascript // Node.js example using axios (install with: npm install axios) const axios = require('axios'); async function getAiActivity() { const url = 'https://api.seismic.com/reporting/v2/aiActivity?limit=1'; const headers = { 'Accept': 'application/json' }; try { const response = await axios.get(url, { headers }); console.log(JSON.stringify(response.data, null, 2)); return response.data; } catch (error) { console.error('Error fetching AI activity:', error); throw error; } } // To run: getAiActivity(); ``` -------------------------------- ### POST /v2/spaces/{spaceId}/programs/template/{templateId}/apply Source: https://developer.seismic.com/seismicsoftware/reference/apply-program-template Applies a program template to create a new program. It returns a list of asynchronous action IDs that can be used to track the progress of the program creation. ```APIDOC ## POST /v2/spaces/{spaceId}/programs/template/{templateId}/apply ### Description Create and return a program from a program template. Once the program is created, a list of async action IDs is returned. This can be used via the Async Action endpoint to determine progress of the creation action. ### Method POST ### Endpoint /v2/spaces/{spaceId}/programs/template/{templateId}/apply ### Parameters #### Path Parameters - **spaceId** (string) - Required - Space ID - **templateId** (string) - Required - The Id of the template to be applied #### Request Body - **title** (string) - Optional - Title of program - **description** (string) - Optional - Description of program - **plannedStartDate** (string) - Optional - Planned start date (date-time format) - **plannedEndDate** (string) - Optional - Planned end date (date-time format) - **plannedDuration** (integer) - Optional - Planned duration in days - **managerId** (string) - Optional - User ID of manager - **removeAssignees** (boolean) - Optional - If true, remove assignees from the program ### Request Example ```json { "title": "My New Program", "description": "This is a program created from a template.", "plannedStartDate": "2023-10-27T10:00:00Z", "plannedEndDate": "2023-11-27T10:00:00Z", "plannedDuration": 30, "managerId": "user123", "removeAssignees": false } ``` ### Response #### Success Response (201) - **asyncActionIds** (array) - A list of IDs for asynchronous actions performed. #### Response Example ```json { "asyncActionIds": [ "action-abc-123", "action-def-456" ] } ``` #### Error Response (400, 401, 500) - **code** (string) - The error code. - **message** (string) - A detailed error message. - **details** (object) - Additional error details. ``` -------------------------------- ### Seismic API GET Request Response Example Source: https://developer.seismic.com/seismicsoftware/reference/request This is an example of a successful response (HTTP 200) from a Seismic API GET request. It outlines the structure of the returned JSON, including count, cursor, and an array of items with detailed properties. ```json { "count": 0, "cursor": "string", "items": [ { "spaceId": "string", "assigneeId": "string", "creatorId": "string", "assignerId": "string", "id": "string", "title": "string", "statusSchemaId": "string", "stepId": 0, "programId": "string", "priority": "low", "plannedStartDate": "2026-01-12T18:51:42.432Z", "plannedEndDate": "2026-01-12T18:51:42.432Z", "plannedDuration": 0, "note": "string", "followers": [ { "id": "string", "type": "user" } ], "rank": "string", "customProperties": [ { "id": "string", "localizations": { "additionalProp": { "name": "string" } }, "multipleValue": true, "name": "string", "values": [ { "id": "string" } ] } ] } ] } ``` -------------------------------- ### API Example: Meeting and Next Steps Topics Source: https://developer.seismic.com/seismicsoftware/reference/getmeetingtranscriptlistasync An example of an API response showing transcribed text with associated topics and keywords. This specific example includes 'Meetings' and 'Next Steps' topics, with keywords like 'zoom' and 'meet'. ```json { "hasMore": false, "totalCount": 1, "items": [ { "start": "2023-08-29T03:01:28.73Z", "end": "2023-08-29T03:01:30.41Z", "speaker": "Thomas Fang", "externalSpeakerId": "", "text": "Thomas Fang: Zoom meet your woman about", "topics": [ { "name": "Meetings", "keywords": [ { "name": "zoom", "count": 1, "fuzzyMatchedKeywords": [ "zoom" ] }, { "name": "meet", "count": 1, "fuzzyMatchedKeywords": [ "meet", "meeting" ] } ] }, { "name": "Next Steps", "keywords": [ { "name": "meet", "count": 1, "fuzzyMatchedKeywords": [ "meet", "meeting" ] } ] } ], "hasQuestion": false }, { "start": "2023-08-29T03:01:38.95Z", "end": "2023-08-29T03:01:39.76Z", "speaker": "Ward Liu", "externalSpeakerId": "", "text": "Ward Liu: God.", "topics": [], "hasQuestion": false } ] } ``` -------------------------------- ### Get Collaborators Response Example Source: https://developer.seismic.com/seismicsoftware/reference/engagement-permission This is an example of a successful response (200 OK) when retrieving collaborators for an engagement. The response is a JSON array of objects, where each object represents a role and contains a list of users associated with that role. ```json [ { "role": "Owner", "users": [ { "id": "string", "name": "string", "email": "string", "firstName": "string", "lastName": "string", "fullName": "string" } ] } ] ``` -------------------------------- ### Create Program Template (POST) Source: https://developer.seismic.com/seismicsoftware/reference/create-program-template This endpoint allows for the creation of a program template within a specified space. It supports custom properties and associations with existing tasks or content. Requires 'seismic.planner.manage' scope and Bearer token authentication. ```json { "openapi": "3.0.3", "info": { "contact": { "name": "Seismic", "email": "api@seismic.com" }, "description": "API endpoints for the Enablement Planner Service API (V2)", "title": "Programs", "version": "v2" }, "servers": [ { "url": "https://api.seismic.com/programs" } ], "tags": [ { "description": "Program Template endpoints", "name": "Program Template" } ], "paths": { "/v2/spaces/{spaceId}/programs/template": { "post": { "tags": [ "Program Template" ], "summary": "Create program template", "x-seismic-release": "GA", "description": "Create a program template.\n\nA program can include not only its main attributes but also custom properties and associations.\n\nCustom properties can be discovered through the custom property endpoint and added to a program as long as the custom property has a designated `program` scope.\n\nAssoications can either be existing tasks without a program or a piece of content from the library that can be discovered via the Library APIs.", "operationId": "create-program-template", "parameters": [ { "name": "spaceId", "in": "path", "description": "Space ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The planner program template data", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateProgramTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateProgramTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProgramTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateProgramTemplate" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlannerProgramTemplate" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-seismic-scopes": [ "seismic.planner.manage" ] } } }, "components": { "securitySchemes": { "JWT_Bearer_Token": { "type": "apiKey", "description": "Standard Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}"", "name": "Authorization", "in": "header" } }, "schemas": { "Association": { "type": "object", "properties": { "spaceId": { "type": "string", "description": "Space ID" }, "spaceGuid": { "type": "string", "description": "Space GUID", "nullable": true, "readOnly": true }, "nodeId": { "type": "string", "description": "Node ID" }, "nodeGuid": { "type": "string", "description": "Node GUID", "nullable": true, "readOnly": true }, "nodeType": { "enum": [ "program", "task", "taskTemplate", "request", "content" ], "type": "string", "description": "Node type of the association" }, "name": { "type": "string", "description": "Name of association" }, "description": { "type": "string", "description": "Description of association" } }, "additionalProperties": false } } } } ``` -------------------------------- ### POST /v2/spaces/{spaceId}/programs/{programId}/makeTemplate Source: https://developer.seismic.com/seismicsoftware/reference/make-program-template Creates a program template from an existing program. This template can then be used to create new programs. The response includes a list of async operation IDs to track the creation progress. ```APIDOC ## POST /v2/spaces/{spaceId}/programs/{programId}/makeTemplate ### Description Create a program template from an existing program. This program template can be used to create other programs via the `apply` template endpoint. Once the template is created, a list of async action IDs is returned. This can be used via the Async Action endpoint to determine progress of the creation action. ### Method POST ### Endpoint /v2/spaces/{spaceId}/programs/{programId}/makeTemplate ### Parameters #### Path Parameters - **spaceId** (string) - Required - Space ID - **programId** (string) - Required - The Id of the template to be applied #### Request Body - **Template overrides** (object) - Optional - Allows for specifying overrides when creating the template. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (201) - **asyncOperationIds** (array[string]) - List of async action IDs #### Response Example ```json { "asyncOperationIds": [ "string" ] } ``` #### Error Response (400, 401, 500) - **errors** (array[object]) - List of error responses - **errorIdentifier** (string) - Optional - Error identifier - **message** (string) - Error message #### Error Response Example ```json { "errors": [ { "errorIdentifier": "string", "message": "string" } ] } ``` ``` -------------------------------- ### Get OpenID Configuration - Example Response (JSON) Source: https://developer.seismic.com/seismicsoftware/reference/additional-oidc-information Provides an example of a successful JSON response when retrieving the OpenID configuration. It includes details about the access token, expiration time, and token type. ```json { "access_token": "JWT access_token here", "expires_in": 21600, "token_type": "Bearer" } ```