Org Explorer

sfp server API reference for Org Explorer: 8 endpoints.

GET/sfp/api/orgs/explorer/components

Authorization

access-token
AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

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

orgUsername*string

Salesforce org username

metadataType*string

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

memberName*string

Member name

refresh?boolean

If true, triggers an async refresh and returns pending status

Defaultfalse

Response Body

curl -X GET "https://example.com/sfp/api/orgs/explorer/components?repositoryIdentifier=string&orgUsername=string&metadataType=string&memberName=string"
Empty
GET/sfp/api/orgs/explorer/components/list

Authorization

access-token
AuthorizationBearer <token>

In: header

Query Parameters

orgUsername*string

Salesforce org username

metadataType?string

Filter by metadata type

Response Body

curl -X GET "https://example.com/sfp/api/orgs/explorer/components/list?orgUsername=string"
Empty
GET/sfp/api/orgs/explorer/metadata

Authorization

access-token
AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

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

orgUsername*string

Salesforce org username

Response Body

curl -X GET "https://example.com/sfp/api/orgs/explorer/metadata?repositoryIdentifier=string&orgUsername=string"
Empty
POST/sfp/api/orgs/explorer/metadata/refresh

Authorization

access-token
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/sfp/api/orgs/explorer/metadata/refresh" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "string",    "orgUsername": "string"  }'
Empty
POST/sfp/api/orgs/explorer/internal/components

Authorization

access-token
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/sfp/api/orgs/explorer/internal/components" \  -H "Content-Type: application/json" \  -d '{    "orgUsername": "string",    "metadataType": "string",    "memberName": "string",    "sourceData": [      {        "fileName": "string",        "fullName": "string",        "type": "string",        "fileContent": "string",        "state": "string"      }    ]  }'
Empty
POST/sfp/api/orgs/explorer/internal/components/batch

Authorization

access-token
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/sfp/api/orgs/explorer/internal/components/batch" \  -H "Content-Type: application/json" \  -d '{    "orgUsername": "string",    "components": [      {        "metadataType": "string",        "memberName": "string",        "sourceData": [          {            "fileName": "string",            "fullName": "string",            "type": "string",            "fileContent": "string",            "state": "string"          }        ]      }    ]  }'
Empty
POST/sfp/api/orgs/explorer/internal/components/manifest-batch

Authorization

access-token
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/sfp/api/orgs/explorer/internal/components/manifest-batch" \  -H "Content-Type: application/json" \  -d '{    "orgUsername": "string",    "components": [      {        "metadataType": "string",        "memberName": "string",        "sourceData": [          {            "fileName": "string",            "fullName": "string",            "type": "string",            "state": "string",            "objectKey": "string",            "contentType": "string",            "sizeBytes": 0,            "sha256": "string",            "fetchedAt": "string"          }        ]      }    ]  }'
Empty
POST/sfp/api/orgs/explorer/internal/metadata-sync

Authorization

access-token
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/sfp/api/orgs/explorer/internal/metadata-sync" \  -H "Content-Type: application/json" \  -d '{    "orgUsername": "string",    "typeNames": [      "string"    ],    "syncedAt": "string",    "duration": 0,    "typesCount": 0,    "componentsCount": 0,    "filesRetrieved": 0,    "failedTypes": [      "string"    ]  }'
Empty