Api Documentation Data Structures
{
"config": {
"contentType": "string",
"integrationId": "string",
"repository": "string",
"branch": "string",
"path": "string"
},
"createdAt": "string",
"createdBy": "string",
"description": "string",
"id": "string",
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"syncEnabled": "boolean",
"typeId": "string"
}
Source custom configuration
Creation time
Created By
Content Source description
Content Source id
Update time
Updated By
Content Source name
Associated org
Associated projects
Is Sync Enabled
Sync related properties
Content Source type
{
"_embedded": [
{
"config": {
"contentType": "string",
"integrationId": "string",
"repository": "string",
"branch": "string",
"path": "string"
},
"createdAt": "string",
"createdBy": "string",
"description": "string",
"id": "string",
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"syncEnabled": "boolean",
"typeId": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
}
{
"downloadUrl": "string",
"title": "string",
"type": "string"
}
Document Link
Document Title
Document Type
{
"message": "string"
}
Execution Message
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
deprecation
href
hreflang
media
rel
templated
title
type
{
"description": "string",
"developer": "string",
"displayName": "string",
"documents": [
{
"downloadUrl": "string",
"title": "string",
"type": "string"
}
],
"eula": "string",
"highlights": [
"string"
],
"icon": "string",
"id": "string",
"overview": "string",
"rating": "string",
"screenshots": [
"string"
],
"support": {
"email": "string",
"hours": "string",
"phone": "string",
"statement": "string",
"url": "string"
},
"techSpecs": "string",
"totalReviews": "integer",
"updatedAt": "string",
"version": "string",
"video": "string"
}
Description
Developer
Display Name
EULA
Highlights
Icon
ID
Overview
Rating
Screenshots
Tech Specs
Total Reviews
Updated Date
Version
Video
{
"contentId": "string",
"contentName": "string",
"contentType": "string",
"createdAt": "string",
"downloadedContentId": "string",
"executionMessages": [
{
"message": "string"
}
],
"id": "string",
"lastUpdatedAt": "string",
"sourceId": "string",
"status": "string",
"targetId": "string",
"targetType": "string"
}
Content Id
Content Name
Content Type
Request Created Time
Downloaded Content Id
Request Id
Request Last Updated Time
Content Source Id
Request Status
Target Id
Target Type
{
"id": "string",
"link": "string"
}
Content Id
Content Link
{
"comment": "string",
"contentId": "string",
"id": "string",
"rating": "string",
"title": "string",
"user": "string"
}
Comment
Content ID
Review ID
Rating
Title
User
{
"_embedded": [
{
"comment": "string",
"contentId": "string",
"id": "string",
"rating": "string",
"title": "string",
"user": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
}
{
"_embedded": [
{
"description": "string",
"developer": "string",
"displayName": "string",
"documents": [
{
"downloadUrl": "string",
"title": "string",
"type": "string"
}
],
"eula": "string",
"highlights": [
"string"
],
"icon": "string",
"id": "string",
"overview": "string",
"rating": "string",
"screenshots": [
"string"
],
"support": {
"email": "string",
"hours": "string",
"phone": "string",
"statement": "string",
"url": "string"
},
"techSpecs": "string",
"totalReviews": "integer",
"updatedAt": "string",
"version": "string",
"video": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
}
{
"_embedded": [
{
"contentId": "string",
"contentName": "string",
"contentType": "string",
"downloadedOn": "string",
"id": "string",
"status": "string",
"targetId": "string",
"targetName": "string",
"targetType": "string",
"updatedOn": "string",
"username": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
}
{
"contentId": "string",
"contentName": "string",
"contentType": "string",
"downloadedOn": "string",
"id": "string",
"status": "string",
"targetId": "string",
"targetName": "string",
"targetType": "string",
"updatedOn": "string",
"username": "string"
}
Downloaded Content Id
Downloaded Content Name
Downloaded Content Type
Downloaded On
History Id
Download Status
Target Id
Target Name
Target Type
Updated On
Username
{
"entries": {
"_embedded": [
{
"count": "integer",
"id": "string",
"name": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
},
"id": "string",
"name": "string",
"type": "string",
"valueType": "string"
}
Filter Id
Filter Display Name
Filter Type
Filter Value Type
{
"_embedded": [
{
"count": "integer",
"id": "string",
"name": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
}
{
"count": "integer",
"id": "string",
"name": "string"
}
Entry count for this filter
id
Filter Entry Display Name
{
"filters": [
{
"entries": {
"_embedded": [
{
"count": "integer",
"id": "string",
"name": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
},
"id": "string",
"name": "string",
"type": "string",
"valueType": "string"
}
]
}
{
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
number
size
totalElements
totalPages
{
"projectIds": [
"string"
]
}
Project Ids
{
"_embedded": [
{
"contentFullPath": "string",
"contentName": "string",
"contentType": "string",
"details": [
"string"
],
"id": "string",
"integrationId": "string",
"projectId": "string",
"projectName": "string",
"requestId": "string",
"sourceId": "string",
"status": "string",
"timestamp": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
}
{
"contentFullPath": "string",
"contentName": "string",
"contentType": "string",
"details": [
"string"
],
"id": "string",
"integrationId": "string",
"projectId": "string",
"projectName": "string",
"requestId": "string",
"sourceId": "string",
"status": "string",
"timestamp": "string"
}
Content Full Path
Content Name
Content Type
Details
Unique Id for the Source Control History
Integration Id
Project Id
Project Name
Id of the sync request
Content source Id
Status
Timestamp
{
"createdAt": "string",
"lastUpdatedAt": "string",
"message": "string",
"projectId": "string",
"requestId": "string",
"sourceId": "string",
"status": "string"
}
Created at
Last Updated at
Message
Project Id
Request Id
Content Source Id
Status
{
"_embedded": [
{
"createdAt": "string",
"lastUpdatedAt": "string",
"message": "string",
"projectId": "string",
"requestId": "string",
"sourceId": "string",
"status": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
}
{
"email": "string",
"hours": "string",
"phone": "string",
"statement": "string",
"url": "string"
}
Support Email
Support Hours
Support Phone
Support Statement
Support URL