{"items":[{"type":"link","label":"Graph API","link":"/ch/graph-api","routeSlug":"/ch/graph-api","content":{"contentType":"overview","meta":{"name":"Graph API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/ch/graph-api/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/ch/graph-api/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"closed source","url":"https://www.sitecore.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Graph API (v1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Graph API to manage and monitor graph rebuild operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This REST API lets users track the status and progress of graph rebuild processes, including start and end times, as well as whether an operation was aborted.  It provides endpoints for retrieving graph rebuild data with support for pagination and filtering."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use graph endpoints, you must either be a superuser or have the necessary permissions granted  to you through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/users/content-hub/user-group-policies.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user group policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]}]}]}]}]}],"sectionId":"/ch/graph-api"}],"sectionId":"/ch/graph-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this API, you need:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of your Content Hub server. You can get this from your Content Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Administrator. Enter this URL in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{{server}}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" variable by hovering your mouse"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"over the variable in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pane and then clicking "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An access token and the client ID. Both are sent with every request. You"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can create a token through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/users/content-hub/create-an-oauth-client.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interface"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#grant-flows"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requesting one using the API"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"itself"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"sectionId":"/ch/graph-api/section/authentication"}]}]}},{"type":"link","label":"Authentication","link":"/ch/graph-api/section/authentication","routeSlug":"/ch/graph-api/section/authentication","content":null},{"type":"group","label":"Graph","link":"/ch/graph-api/graph","routeSlug":"/ch/graph-api/graph","items":[{"label":"Retrieve graph rebuild data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/graph-api/graph/graph-rebuild","routeSlug":"/ch/graph-api/graph/graph-rebuild","metadata":{"seo":{"title":"Retrieve graph rebuild data","description":"Retrieves a paginated list of graph rebuild data, including total number of rebuilds. All parameters are optional."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"graph-rebuild","name":"Retrieve graph rebuild data","isWebhook":false,"pointer":"/paths/~1api~1graph~1v1~1rebuilds/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve graph rebuild data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a paginated list of graph rebuild data, including total number of rebuilds. All parameters are optional."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"skip","in":"query","schemaId":"schema_934","description":"The number of entities to skip for pagination."},{"name":"take","in":"query","schemaId":"schema_935","description":"The number of entities to take for pagination. Valid values are between 1 and 100."},{"name":"startMonth","in":"query","schemaId":"schema_936","description":"The start month filter for the graph rebuild entities."},{"name":"startYear","in":"query","schemaId":"schema_936","description":"The start year filter for the graph rebuild entities."}],"pointer":"/paths/~1api~1graph~1v1~1rebuilds/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/graph/v1/rebuilds","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[{"name":"skip","in":"query","schemaId":"schema_934"},{"name":"take","in":"query","schemaId":"schema_935"},{"name":"startMonth","in":"query","schemaId":"schema_936"},{"name":"startYear","in":"query","schemaId":"schema_936"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/graph/v1/rebuilds","href":"graph/graph-rebuild","openApiOperationId":"graph-rebuild","summary":"Retrieve graph rebuild data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GraphRebuildCollectionResource"}},"schemaId":"components/schemas/GraphRebuildCollectionResource"},{"code":"400","description":"Request is not valid"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Insufficient permissions"}],"pointer":"/paths/~1api~1graph~1v1~1rebuilds/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GraphRebuildCollectionResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GraphRebuildCollectionResource"}}},{"code":"400"},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/graph/graph-rebuild"}],"panels":[]}]},"httpPath":"/api/graph/v1/rebuilds"}],"content":{"contentType":"group","meta":{"name":"Graph"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Graph","showPageActions":true},{"nodeType":"markdoc","content":"The Graph API provides tools for overseeing and controlling graph rebuild activities."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/graph/v1/rebuilds","summary":"Retrieve graph rebuild data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/graph/graph-rebuild","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/GraphRebuildCollectionResource":{"id":"components/schemas/GraphRebuildCollectionResource","kind":"json-schema","title":"GraphRebuildCollectionResource","data":{"type":"object","properties":{"rebuilds":{"type":"array","items":{"$ref":"#/components/schemas/GraphRebuildResource"},"description":"Collection of Stylelabs.M.Web.Api.Models.Base.GraphRebuildResource objects representing rebuilds.","nullable":true},"total_rebuilds":{"type":"integer","description":"The total number of rebuilds available.","format":"int64"},"returned_rebuilds":{"type":"integer","description":"The number of rebuilds returned in the current response.","format":"int64"},"offset":{"type":"integer","description":"The offset used for the pagination of rebuilds.","format":"int32"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents a collection resource for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stylelabs.M.Web.Api.Models.Base.GraphRebuildResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects. Inherits from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stylelabs.M.Base.Web.Api.Models.ListResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1`."},"children":[]}]}]}]}},"components/schemas/GraphRebuildResource":{"id":"components/schemas/GraphRebuildResource","kind":"json-schema","title":"GraphRebuildResource","data":{"required":["start"],"type":"object","properties":{"start":{"type":"string","description":"The timestamp when the graph rebuild started.","format":"date-time"},"end":{"type":"string","description":"The timestamp when the graph rebuild ended if available.","format":"date-time","nullable":true},"aborted":{"type":"boolean","description":"Whether the graph rebuild was aborted."},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Represents a resource for tracking the rebuild of a graph."}},"components/schemas/Link":{"id":"components/schemas/Link","kind":"json-schema","title":"Link","data":{"type":"object","properties":{"href":{"type":"string","description":"Gets or sets the URI that points to the resource this link refers to.","nullable":true},"filename_properties":{"type":"array","items":{"type":"string"},"description":"Gets or sets the URI that points to the resource this link refers to.","nullable":true},"title":{"type":"string","description":"Gets or sets the title that describes this link.","nullable":true},"templated":{"type":"boolean","description":"Gets or sets a value indicating whether the contained URI is a template.","default":false}},"additionalProperties":false,"description":"Represents a link to a resource."}},"schema_934":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":0},"id":"schema_934"},"schema_935":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":25},"id":"schema_935"},"schema_936":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_936"}},"exampleStore":{},"securitySchemeStore":{"OAuth2.0":{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}},"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"specType":"openapi"},"options":{"hideInfoMetadata":true,"sanitize":true,"sortRequiredPropsFirst":true,"corsProxyUrl":"https://cors.redoc.ly","mockServer":{"off":true,"position":"off"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/ch/graph-api/index.json?download"},{"url":"/_bundle/ch/graph-api/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Graph API","description":"Use the Graph API to manage and monitor graph rebuild operations.<br><br> This REST API lets users track the status and progress of graph rebuild processes, including start and end times, as well as whether an operation was aborted.  It provides endpoints for retrieving graph rebuild data with support for pagination and filtering.\n{% admonition type=\"info\" name=\"Note\" %}To use graph endpoints, you must either be a superuser or have the necessary permissions granted  to you through [user group policies](https://doc.sitecore.com/ch/en/users/content-hub/user-group-policies.html). {% /admonition %}\n## Authentication\nTo use this API, you need:\n\n- The URL of your Content Hub server. You can get this from your Content Hub\n  Administrator. Enter this URL in the <b>{{server}}</b> variable by hovering your mouse \n  over the variable in the <b>Try it</b> pane and then clicking <b>Edit</b>.\n\n- An access token and the client ID. Both are sent with every request. You \n  can create a token through the [Content Hub\n  interface](https://doc.sitecore.com/ch/en/users/content-hub/create-an-oauth-client.html) \n  or by [requesting one using the API\n  itself](https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#grant-flows).\n","product":"Content Hub"}},"baseSlug":"/ch/graph-api","routesMapping":{}}