Post APIs

To upload data to the Lifecycle Sleuth Database, a user must post a JSON object to a particular API. Listed below is each API, along with the structure of the corresponding JSON object.

Post Activity

Add/Update/Delete Activities in a Model.

URL:  www.clearlyagile.com/ca/api/PostActivity

Token: Key generated on UserInfo call, used to validate post.
ActivityID: int
ModelID: int
Phase: String (Phase Abbreviation)
SequenceID: int
BaseActivity: String (found in BaseInfo)
Notes: String
BestTime: int (in seconds)
TypicalTime: int (in seconds)
WorstTime: int (in seconds)
WasteType: String (found in BaseInfo)
IsRequired: int (1 if true, else 0)
IsAutomated: int (1 if true, else 0)
StepUsers: String

 

Post Artifact

Add/Update/Delete Artifacts.

URL:  www.clearlyagile.com/ca/api/PostArtifact

Token: Key generated on UserInfo call, used to validate post.
ArtifactID: int
Artifact: {
}

 

Post Build

Update Build Configuration of an Organization.

URL:  www.clearlyagile.com/ca/api/PostBuild

Token: Key generated on UserInfo call, used to validate post.
TenantID: Unique Identifier for the organization
Build: {
DailyBuildFrequency: String (Don’t Know, Never, Rarely, Sometimes, Often, Continuously)
NightlyBuildFrequency: String (Don’t Know, Never, Rarely, Sometimes, Often, Continuously)
CanWholeTeamBuild: String (Don’t Know, Yes, No)
BuildTool: String (Names are available in Lookup API under Build Tools)
BuildToolVersion: String (Versions are available in Lookup API under Build Tools)
AreBuildStatusesCommunicated: String (Don’t Know, Automatically, Manually, No)
WhatStatusesAreCommunicated: String (Don’t Know, All CI Events, Just Success, Just Failures)
ModeOfStatusCommunication*: String (Don’t Know, Build Tool, IDE, Email, Verbal)
}
*Multiple values allowed (separate values with “&”)

 

Post Continuous Integration

Update Continuous Integration Configuration of an Organization.

URL:  www.clearlyagile.com/ca/api/PostContinuousIntegration

Token: Key generated on UserInfo call, used to validate post.
TenantID: Unique Identifier for the organization
ContinuousIntegration: {
IsCIUtilized: String (Don’t Know, Yes, No)
CIEngineTriggeredBy: String (Don’t Know, Build Request, Repository Change)
CITool: String (Names are available in Lookup API under CI Tools)
CIToolVersion: String (Versions are available in Lookup API under CI Tools)
AreCIStatusesCommunicated: String (Don’t Know, Automatically, Manually, No)
WhatStatusesAreCommunicated: String (Don’t Know, All CI Events, Just Success, Just Failures)
ModeOfStatusCommunication*: String (Don’t Know, CI Tool, IDE, Email, Verbal)
}
*Multiple values allowed (separate values with “&”)

 

Post Contract

Update Contracts of an Organization.

URL:  www.clearlyagile.com/ca/api/PostContract

Token: Key generated on UserInfo call, used to validate post.
TenantID: TenantID Associated with Organization
ID: Int (make negative to delete, and 0 to add)
ContractID: String
Name: String
SourceDocumentName: String
ContractType: String
StartDate: DateTime
EndDate:DateTime
Status: String
Description: String
Notes: String
TotalValue: String
Owner: Int (Found in Organization API under People)

 

Post Development Tools

Update Development Tools of an Organization.

URL:  www.clearlyagile.com/ca/api/PostDevelopmentTools

Token: Key generated on UserInfo call, used to validate post.
TenantID: TenantID Associated with Organization
SupportedPlatforms: String (Found in Lookup API, if multiple, separate with &)
iOSVersion: String (Found in Lookup API, if multiple, separate with &)
iOSIDE: String (Found in Lookup API, if multiple, separate with &)
AndroidVersion: String (Found in Lookup API, if multiple, separate with &)
AndroidIDE: String (Found in Lookup API, if multiple, separate with &)
WebFrameworks: String (Found in Lookup API, if multiple, separate with &)
ResponsiveFrameworks: String (Found in Lookup API, if multiple, separate with &)
WebBrowsers: String (Found in Lookup API, if multiple, separate with &)
NETVersion: String (Found in Lookup API, if multiple, separate with &)
NETIDE: String (Found in Lookup API, if multiple, separate with &)
NETFramework: String (Found in Lookup API, if multiple, separate with &)
JaveVersion: String (Found in Lookup API, if multiple, separate with &)
JaveIDE: String (Found in Lookup API, if multiple, separate with &)

 

Post Delivery And Deployment

Add/Update/Delete Delivery and Deployment Environments of an Organization.

Coming Soon!

Post Development Tools Libraries

Add/Update/Delete Development Tools Libraries for an Organization.

URL:  www.clearlyagile.com/ca/api/PostDevelopmentToolsLibraries

Token: Key generated on UserInfo call, used to validate post.
TenantID: TenantID Associated with Organization
Library: {
LibraryID: Int (Can be found in Organization API under Development Tools Libraries)
Name: String
Version: String
Status: String (Supported, Deprecated, Retired)
Description: String
Notes: String
URL: String
}

 

Post Governance Framework

Add/Update/Delete Governance Framework of an Organization.

URL:  www.clearlyagile.com/ca/api/PostGovernanceFramework

Token: Key generated on UserInfo call, used to validate post.
OrganizationID: ID for the organization
GovernanceFramework: {
GovernanceFrameworkID: Int
BaselineVersion: String
Description: String
Name: String
Notes: String
ReadOnly: Boolean
StatusCode: String
}

 

Post Image

Update Image of an Organization or Person.

URL:  www.clearlyagile.com/ca/api/PostImage

Token: Key generated on UserInfo call, used to validate post.
ID: Unique Identifier for the organization, or Person ID
Table: Name of the table to be updated (‘Organization’ or ‘Person’)
Image: Base64 Encoding of the image to be updated

 

Post Location

Add/Update/Delete Locations of an Organization.

URL:  www.clearlyagile.com/ca/api/PostLocation

Token: Key generated on UserInfo call, used to validate post.
OrganizationID: Unique Identifier for the organization (TenantID)
LocationInfo: {
LocationID: Int (Can be found in Organization API under Locations. Use “0” to create a new Location, and the negative of a Location_ID to delete that Location)
Name: String
Street1: String (Address Line 1)
Street2: String (Address Line 2)
City: String
StateProvince: String (2 Character code found in BaseInfo API under ISOCountryCodes[i].States)
PostalCode: String
Longitude: Strin
Latitude: String
PhoneNumber: String
OfficeType: String (Unknown, Corporate, Satellite)
ISOCountryCode2: String (2 Character code found in BaseInfo API under ISOCountryCodes)
PrimaryContact: Int (Identifier for a Person, found in Organization API under People)
}

 

Post Model

Add/Update/Delete Models of an Organization.

URL:  www.clearlyagile.com/ca/api/PostModel

Token: Key generated on UserInfo call, used to validate post.
TenantID: Unique Identifier for the organization
ModelInfo: {
ModelID: Int (Can be found in UserInfo API under Users_Models. Use “0” to create a new Model, and the negative of a ModelID to delete that Model)
ModelName: String
ModelType: String (Type of Solution: Microservice, Mobile, Office, Service, Sharepoint, Web)
BaselineVersion: String
StatusCode: String (Draft, AS-IS, TO-BE, Closed)
Notes: String
SolutionName: String
Owner: Int (Identifier for a Person, found in Organization API under People)
Description: String
}

 

Post Organization

Update Information of an Organization.

URL:  www.clearlyagile.com/ca/api/PostOrganization

Token: Key generated on UserInfo call, used to validate post.
TenantID: Unique Identifier for the organization
Organization: {
LegalName: String
OrganizationType: String (Business, Government, Other)
Notes: String
PhoneNumber: String
Email: String
Internet: String (include http:// or https://)
Intranet: String (include http:// or https://)
CustomerSuccessAdvocate: Int (Identifier for a Clearly Agile person, found in Company API under Company_Users)
ChampionPrimary: Int (Identifier for a Person, found in Organization API under People)
ChampionSecondary: Int (Identifier for a Person, found in Organization API under People)
SubscriptionAdministratorPrimary: Int (Identifier for a Person, found in Organization API under People)
SubscriptionAdministratorSecondary: Int (Identifier for a Person, found in Organization API under People)
RiskManagementPrimary: Int (Identifier for a Person, found in Organization API under People)
RiskManagementSecondary: Int (Identifier for a Person, found in Organization API under People)
}

 

Post Person

Add/Update/Delete People of an Organization.

URL:  www.clearlyagile.com/ca/api/PostPerson

Token: Key generated on UserInfo call, used to validate post.
OrganizationID: Unique Identifier for the organization (Tenant_ID)
PersonInfo: {
PersonID: Int (Can be found in UserInfo API under Users_Models. Use “0” to create a new Model, and the negative of a PersonID to delete that Model)
FirstName: String
LastName: String (Type of Solution: Microservice, Mobile, Office, Service, Sharepoint, Web)
PreferredName: String
PrimaryEmail: String (Draft, AS-IS, TO-BE, Closed)
SecondaryEmail: String
WorkNumber: String
PreferredPhoneType: String (Work, Cell, Home, Unknown)
BaseLocation: String (LocationKey from BaseInfo API under Base_Locations)
CellNumber: String
HomeNumber: String
DefaultRole: String
UserInfo: User Object (found in Organization API under Users: Can be left null)
OfficeLocation: Int (Identifier for a Location, found in Organization API under Locations)
IsEnabled: String (“1” for true, “0” for false)
DefaultHourlyRate: Decimal
}

 

Post Portfolio

Add/Update/Delete Portfolios of an Organization.

URL:  www.clearlyagile.com/ca/api/PostPortfolio

Token: Key generated on UserInfo call, used to validate post.
OrganizationID: ID for the organization
Portfolio: {
PortfolioID: Int
OwnerID: Int
Description: String
Name: String
Notes: String
IsActive: Boolean
}

 

Post Product

Add/Update/Delete Products of an Organization.

URL:  www.clearlyagile.com/ca/api/PostProduct

Token: Key generated on UserInfo call, used to validate post.
OrganizationID: ID for the organization
Product: {
ProductID: Int
ProgramID: Int
OwnerID: Int
Description: String
Name: String
Notes: String
IsActive: Boolean
}

 

Post Program

Add/Update/Delete Programs of an Organization.

URL:  www.clearlyagile.com/ca/api/PostProgram

Token: Key generated on UserInfo call, used to validate post.
OrganizationID: ID for the organization
Program: {
ProgramID: Int
PortfolioID: Int
OwnerID: Int
Description: String
Name: String
Notes: String
IsActive: Boolean
}

 

Post Project

Add/Update/Delete Projects of an Organization.

URL:  www.clearlyagile.com/ca/api/PostProject

Token: Key generated on UserInfo call, used to validate post.
OrganizationID: ID for the organization
Project: {
ProjectID: Int
OwnerID: Int
Description: String
Name: String
Notes: String
IsActive: Boolean
}

 

Post Task

Add/Update/Delete Task in a Model.

URL:  www.clearlyagile.com/ca/api/PostTask

Token: Key generated on UserInfo call, used to validate post.
TaskID: Int
Phase: String
PersonID: Int (Identifier for a Person, found in Organization API under People)
Notes: String
StartingDate: Datetime
CompleteDate: Datetime
TargetStart: Datetime
TargetComplete: Datetime

 

Post Team

Add/Update/Delete Team of an Organization.

URL:  www.clearlyagile.com/ca/api/PostTeam

Token: Key generated on UserInfo call, used to validate post.
TenantID: Unique Identifier for the organization
TeamInfo: {
TeamID: Int (Can be found in Organization API under Teams. Use “0” to create a new Team, and the negative of a Team_ID to delete that Team)
Abbreviation: String (Found in Base Info API under Base_Team_Type_List)
TeamName: String (Type of Solution: Microservice, Mobile, Office, Service, Sharepoint, Web)
TeamDeliveryFramework: String (Found in Lookup API under Team_Framework)
IsShared: String (“1” for true, “0” for false)
IsActive: String (“1” for true, “0” for false)
Description: String
Notes: String
BaseLocation: String (LocationKey from BaseInfo API under Base_Locations)
OfficeLocation: Int (Identifier for a Location, found in Organization API under Locations)
}

 

Post Team Member

Add/Update/Delete Team Member of an Organization.

URL:  www.clearlyagile.com/ca/api/PostTeamMember

Token: Key generated on UserInfo call, used to validate post.
Procedure: (+1: update, 0: add, -1: delete)
TeamMember: {
TeamID: Int (Can be found in Organization API under Teams)
PersonID: Int (Identifier for a Person, found in Organization API under People)
Role: String (Found in Base Info API under Base_Role_Types)
HourlyRate: Decimal (per hour)
DedicationPercent: Decimal (0-100)
}

 

Post User

Add/Update/Delete User of an Organization.

URL:  www.clearlyagile.com/ca/api/PostUser

Token: Key generated on UserInfo call, used to validate post.
TenantID: Unique Identifier for the organization
PersonID: Int (Identifier for a Person, found in Organization API under People)
User: {
UserID: Int (Can be found in Organization API under Users)
UserName: String
IsActive: Bool
CanViewFinancials: Bool
IsProductAdministrator: Bool
BRAdmin: Bool
BRReadOnly: Bool
BRFinancials: Bool
LSAdmin: Bool
LSReadOnly: Bool
LSFinancials: Bool
WAdmin: Bool
WReadOnly: Bool
WFinancials: Bool
}

Follow Us!         

info@ClearlyAgile.com     support@ClearlyAgile.com     careers@ClearlyAgile.com     training@ClearlyAgile.com

(833) AGILE 4 U     (833) 244-5348

Copyright © 2016, Clearly Agile, Inc. All Rights Reserved.