Org Explorer

Get stored component source data. Pass refresh=true to trigger async re-fetch.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier (e.g., owner/repo)

orgUsernamestringRequired

Salesforce org username

metadataTypestringRequired

Metadata type (e.g., ApexClass, CustomObject)

memberNamestringRequired

Member name

refreshbooleanOptional

If true, triggers an async refresh and returns pending status

Default: false

Responses

200

Stored component data, not_found, or pending status

No content

403

Forbidden - Requires role: member, owner, application

get/sfp/api/orgs/explorer/components

GET /sfp/api/orgs/explorer/components?repositoryIdentifier=text&orgUsername=text&metadataType=text&memberName=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List stored components for an org

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

orgUsernamestringRequired

Salesforce org username

metadataTypestringOptional

Filter by metadata type

Responses

200

List of stored components with summary info

No content

403

Forbidden - Requires role: member, owner, application

get/sfp/api/orgs/explorer/components/list

GET /sfp/api/orgs/explorer/components/list?orgUsername=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get org metadata sync summary

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier (e.g., owner/repo)

orgUsernamestringRequired

Salesforce org username

Responses

200

Metadata sync summary or not_synced status

No content

403

Forbidden - Requires role: member, owner, application

get/sfp/api/orgs/explorer/metadata

GET /sfp/api/orgs/explorer/metadata?repositoryIdentifier=text&orgUsername=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Trigger full org metadata sync (describe, list, retrieve all)

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

repositoryIdentifierstringRequired

Repository identifier (e.g., owner/repo)

orgUsernamestringRequired

Salesforce org username

typeFilterstring[]Optional

Optional list of metadata types to limit the sync

Responses

200

Metadata sync triggered

No content

403

Forbidden - Requires role: member, owner, application

post/sfp/api/orgs/explorer/metadata/refresh

POST /sfp/api/orgs/explorer/metadata/refresh HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "repositoryIdentifier": "text",
  "orgUsername": "text",
  "typeFilter": [
    "text"
  ]
}

No content

Publish retrieved org explorer component source to object storage

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

orgUsernamestringRequired

Salesforce org username

metadataTypestringRequired

Salesforce metadata type

memberNamestringRequired

Salesforce metadata member name

retrievedAtstringOptional

ISO timestamp for retrieve completion

durationnumberOptional

Retrieve duration in seconds

Responses

201

Component source stored

No content

403

Forbidden - Requires role: member, owner, application

post/sfp/api/orgs/explorer/internal/components

POST /sfp/api/orgs/explorer/internal/components HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 267

{
  "orgUsername": "text",
  "metadataType": "text",
  "memberName": "text",
  "parent": {
    "metadataType": "text",
    "memberName": "text",
    "key": "text"
  },
  "sourceData": [
    {
      "fileName": "text",
      "fullName": "text",
      "type": "text",
      "fileContent": "text",
      "state": "text"
    }
  ],
  "retrievedAt": "text",
  "duration": 1
}

No content

Publish a batch of retrieved org explorer components to object storage

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

orgUsernamestringRequired

Salesforce org username

retrievedMetadataTypestringOptional

Metadata type used for the source retrieve that produced this batch

retrievedAtstringOptional

Default ISO timestamp for retrieve completion

durationnumberOptional

Default retrieve duration in seconds

Responses

201

Component source batch stored

No content

403

Forbidden - Requires role: member, owner, application

post/sfp/api/orgs/explorer/internal/components/batch

POST /sfp/api/orgs/explorer/internal/components/batch HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 349

{
  "orgUsername": "text",
  "retrievedMetadataType": "text",
  "components": [
    {
      "metadataType": "text",
      "memberName": "text",
      "parent": {
        "metadataType": "text",
        "memberName": "text",
        "key": "text"
      },
      "sourceData": [
        {
          "fileName": "text",
          "fullName": "text",
          "type": "text",
          "fileContent": "text",
          "state": "text"
        }
      ],
      "retrievedAt": "text",
      "duration": 1
    }
  ],
  "retrievedAt": "text",
  "duration": 1
}

No content

Publish a batch of org explorer component descriptors after internal object upload

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

orgUsernamestringRequired

Salesforce org username

retrievedMetadataTypestringOptional

Metadata type used for the source retrieve that produced this batch

retrievedAtstringOptional

Default ISO timestamp for retrieve completion

durationnumberOptional

Default retrieve duration in seconds

Responses

201

Component descriptor batch stored

No content

403

Forbidden - Requires role: application

post/sfp/api/orgs/explorer/internal/components/manifest-batch

POST /sfp/api/orgs/explorer/internal/components/manifest-batch HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 417

{
  "orgUsername": "text",
  "retrievedMetadataType": "text",
  "components": [
    {
      "metadataType": "text",
      "memberName": "text",
      "parent": {
        "metadataType": "text",
        "memberName": "text",
        "key": "text"
      },
      "sourceData": [
        {
          "fileName": "text",
          "fullName": "text",
          "type": "text",
          "state": "text",
          "objectKey": "text",
          "contentType": "text",
          "sizeBytes": 1,
          "sha256": "text",
          "fetchedAt": "text"
        }
      ],
      "retrievedAt": "text",
      "duration": 1
    }
  ],
  "retrievedAt": "text",
  "duration": 1
}

No content

Publish org explorer metadata sync summary

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

orgUsernamestringRequired

Salesforce org username

typeNamesstring[]Required

Discovered metadata type names

syncedAtstringRequired

ISO timestamp for sync completion

durationnumberRequired

Sync duration in seconds

typesCountnumberRequired

Number of metadata types discovered

componentsCountnumberRequired

Number of metadata components listed

filesRetrievednumberRequired

Number of source files retrieved

failedTypesstring[]Required

Metadata types that failed during sync

Responses

201

Metadata sync summary stored

No content

403

Forbidden - Requires role: member, owner, application

post/sfp/api/orgs/explorer/internal/metadata-sync

POST /sfp/api/orgs/explorer/internal/metadata-sync HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 151

{
  "orgUsername": "text",
  "typeNames": [
    "text"
  ],
  "syncedAt": "text",
  "duration": 1,
  "typesCount": 1,
  "componentsCount": 1,
  "filesRetrieved": 1,
  "failedTypes": [
    "text"
  ]
}

No content

Last updated 2 hours ago

Was this helpful?