openapi

package
v0.0.33 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 27, 2024 License: MIT Imports: 27 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// PathGetRecordsV2 新版接口
	PathGetRecordsV2 = "/api/data/v1/namespaces/:namespace/objects/:objectAPIName/records"

	PathCreateRecordV2      = "/api/data/v1/namespaces/:namespace/objects/:objectAPIName"
	PathBatchCreateRecordV2 = "/api/data/v1/namespaces/:namespace/objects/:objectAPIName/batchCreate"

	PathUpdateRecordV2      = "/api/data/v1/namespaces/:namespace/objects/:objectAPIName/:recordID"
	PathBatchUpdateRecordV2 = "/api/data/v1/namespaces/:namespace/objects/:objectAPIName/batchUpdate"

	PathDeleteRecordV2      = "/api/data/v1/namespaces/:namespace/objects/:objectAPIName/:recordID"
	PathBatchDeleteRecordV2 = "/api/data/v1/namespaces/:namespace/objects/:objectAPIName/batchDelete"

	PathUploadFileV2   = "/api/attachment/v1/files"
	PathUploadAvatar   = "/api/attachment/v1/images"
	PathDownloadFileV2 = "/api/attachment/v1/files/:fileID"
	PathDownloadAvatar = "/api/attachment/v1/images/:fileID"

	// PathGetRecords 老版接口
	PathGetRecords  = "/generic/data/v3/namespaces/:namespace/objects/:objectAPIName/mGetByCriterion"
	PathTransaction = "/generic/datax/v2/namespaces/:namespace/records/_modify_with_transaction"
	PathOql         = "/data/v5/namespaces/:namespace/records/query"

	PathCreateRecord           = "/generic/data/v2/namespaces/:namespace/objects/:objectAPIName/createBySync"
	PathBatchCreateRecord      = "/generic/data/v2/namespaces/:namespace/objects/:objectAPIName/batchCreate"
	PathBatchCreateRecordAsync = "/generic/data/v2/namespaces/:namespace/objects/:objectAPIName/batchCreateByAsync"

	PathUpdateRecord           = "/generic/data/v2/namespaces/:namespace/objects/:objectAPIName/updateBySync"
	PathBatchUpdateRecord      = "/generic/data/v2/namespaces/:namespace/objects/:objectAPIName/batchUpdate"
	PathBatchUpdateRecordAsync = "/generic/data/v2/namespaces/:namespace/objects/:objectAPIName/batchUpdateByAsync"

	PathDeleteRecord           = "/generic/data/v2/namespaces/:namespace/objects/:objectAPIName/deleteBySync"
	PathBatchDeleteRecord      = "/generic/data/v2/namespaces/:namespace/objects/:objectAPIName/batchDelete"
	PathBatchDeleteRecordAsync = "/generic/data/v2/namespaces/:namespace/objects/:objectAPIName/batchDeleteByAsync"

	PathUploadFile   = "/attachment/v2/upload"
	PathDownloadFile = "/attachment/v1/download"

	PathCreateMessage = "/msg/v4/namespaces/:namespace/message_center/notify_task/create"
	PathUpdateMessage = "/msg/v4/namespaces/:namespace/message_center/notify_task/update"

	PathGetAllGlobalConfig = "/generic/globalconfig/v1/namespaces/:namespace/getAllConfigs"

	PathGetField  = "/metadata/v5/namespaces/:namespace/objects/:objectAPIName/fields/:fieldAPIName"
	PathGetFields = "/metadata/v5/namespaces/:namespace/objects/:objectAPIName/describe"

	PathMGetUserSettings = "/setting/v1/users"

	PathInvokeFunctionWithAuth = "/api/cloudfunction/v1/namespaces/:namespace/invoke/:functionAPIName"
	PathInvokeFunctionAsync    = "/faasAsyncTask/v1/namespaces/:namespace/asyncTask/CreateAsyncTask"

	PathGetTaskListByExecutionID = "/api/flow/v1/namespaces/:namespace/executions/:executionId/userTaskInfo"
	PathGetExecutionInfo         = "/api/flow/v1/namespaces/:namespace/executions/:executionId/detail"
	PathRevokeExecution          = "/api/flow/v1/namespaces/:namespace/executions/:executionId/revoke"
	PathExecuteFlow              = "/api/flow/v1/namespaces/:namespace/flows/:apiName/execute"
	PathDefaultTenantAccessToken = "/api/integration/v1/namespaces/:namespace/defaultLark/tenantAccessToken"
	PathDefaultAppAccessToken    = "/api/integration/v1/namespaces/:namespace/defaultLark/appAccessToken"
	PathAppAccessToken           = "/api/integration/v1/namespaces/:namespace/lark/appAccessToken/:apiName"
	PathTenantAccessToken        = "/api/integration/v1/namespaces/:namespace/lark/tenantAccessToken/:apiName"
	PathGetApprovalInstanceList  = "/api/approval/v1/approval_instances/listids"
	PathGetApprovalInstance      = "/api/approval/v1/approval_instances/:recordID"
)

Variables

This section is empty.

Functions

func GetAppAccessTokenPath added in v0.0.23

func GetAppAccessTokenPath(namespace, apiName string) string

func GetDefaultAppAccessTokenPath added in v0.0.23

func GetDefaultAppAccessTokenPath(namespace string) string

func GetDefaultTenantAccessTokenPath added in v0.0.23

func GetDefaultTenantAccessTokenPath(namespace string) string

func GetExecutionUserTaskInfo

func GetExecutionUserTaskInfo(namespace string, executionID int64) string

func GetGetApprovalInstancePath added in v0.0.32

func GetGetApprovalInstancePath(instanceID int64) string

func GetPathBatchCreateRecord

func GetPathBatchCreateRecord(namespace, objectAPIName string) string

func GetPathBatchCreateRecordAsync

func GetPathBatchCreateRecordAsync(namespace, objectAPIName string) string

func GetPathBatchCreateRecordV2

func GetPathBatchCreateRecordV2(namespace, objectAPIName string) string

func GetPathBatchDeleteRecord

func GetPathBatchDeleteRecord(namespace, objectAPIName string) string

func GetPathBatchDeleteRecordAsync

func GetPathBatchDeleteRecordAsync(namespace, objectAPIName string) string

func GetPathBatchDeleteRecordV2

func GetPathBatchDeleteRecordV2(namespace, objectAPIName string) string

func GetPathBatchUpdateRecord

func GetPathBatchUpdateRecord(namespace, objectAPIName string) string

func GetPathBatchUpdateRecordAsync

func GetPathBatchUpdateRecordAsync(namespace, objectAPIName string) string

func GetPathBatchUpdateRecordV2

func GetPathBatchUpdateRecordV2(namespace, objectAPIName string) string

func GetPathCreateMessage

func GetPathCreateMessage(namespace string) string

func GetPathCreateRecord

func GetPathCreateRecord(namespace, objectAPIName string) string

func GetPathCreateRecordV2

func GetPathCreateRecordV2(namespace, objectAPIName string) string

func GetPathDeleteRecord

func GetPathDeleteRecord(namespace, objectAPIName string) string

func GetPathDeleteRecordV2

func GetPathDeleteRecordV2(namespace, objectAPIName string, recordID int64) string

func GetPathDownloadAvatar

func GetPathDownloadAvatar(imageID string) string

func GetPathDownloadFile

func GetPathDownloadFile() string

func GetPathDownloadFileV2

func GetPathDownloadFileV2(fileID string) string

func GetPathExecuteFlow

func GetPathExecuteFlow(namespace, APIName string) string

func GetPathGetAllGlobalConfig

func GetPathGetAllGlobalConfig(namespace string) string

func GetPathGetExecutionInfo

func GetPathGetExecutionInfo(namespace string, executionID int64) string

func GetPathGetField

func GetPathGetField(namespace, objectAPIName, fieldAPIName string) string

func GetPathGetFields

func GetPathGetFields(namespace, objectAPIName string) string

func GetPathGetRecords

func GetPathGetRecords(namespace, objectAPIName string) string

GetPathGetRecords 老版接口

func GetPathGetRecordsV2

func GetPathGetRecordsV2(namespace, objectAPIName string) string

GetPathGetRecordsV2 新版接口

func GetPathInvokeFunctionAsync

func GetPathInvokeFunctionAsync(namespace string) string

func GetPathInvokeFunctionWithAuth

func GetPathInvokeFunctionWithAuth(namespace, functionAPIName string) string

func GetPathMGetUserSettings

func GetPathMGetUserSettings() string

func GetPathOql

func GetPathOql(namespace string) string

func GetPathRevokeExecution

func GetPathRevokeExecution(namespace string, executionID int64) string

func GetPathTransaction

func GetPathTransaction(namespace string) string

func GetPathUpdateMessage

func GetPathUpdateMessage(namespace string) string

func GetPathUpdateRecord

func GetPathUpdateRecord(namespace, objectAPIName string) string

func GetPathUpdateRecordV2

func GetPathUpdateRecordV2(namespace, objectAPIName string, recordID int64) string

func GetTenantAccessTokenPath added in v0.0.23

func GetTenantAccessTokenPath(namespace, apiName string) string

Types

type RequestHttp

type RequestHttp struct{}

func (*RequestHttp) BatchCreateRecord

func (r *RequestHttp) BatchCreateRecord(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, records interface{}) ([]int64, error)

func (*RequestHttp) BatchCreateRecordAsync

func (r *RequestHttp) BatchCreateRecordAsync(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, records interface{}) (int64, error)

func (*RequestHttp) BatchCreateRecordV2

func (r *RequestHttp) BatchCreateRecordV2(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, records interface{}) ([]int64, error)

func (*RequestHttp) BatchDeleteRecord

func (r *RequestHttp) BatchDeleteRecord(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, recordIDs []int64) (*structs.BatchResult, error)

func (*RequestHttp) BatchDeleteRecordAsync

func (r *RequestHttp) BatchDeleteRecordAsync(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, recordIDs []int64) (int64, error)

func (*RequestHttp) BatchDeleteRecordV2

func (r *RequestHttp) BatchDeleteRecordV2(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, recordIDs []int64) error

func (*RequestHttp) BatchUpdateRecord

func (r *RequestHttp) BatchUpdateRecord(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, records map[int64]interface{}) (*structs.BatchResult, error)

func (*RequestHttp) BatchUpdateRecordAsync

func (r *RequestHttp) BatchUpdateRecordAsync(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, records map[int64]interface{}) (int64, error)

func (*RequestHttp) BatchUpdateRecordV2

func (r *RequestHttp) BatchUpdateRecordV2(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, records map[int64]interface{}) error

func (*RequestHttp) CreateMessage

func (r *RequestHttp) CreateMessage(ctx context.Context, appCtx *structs.AppCtx, param map[string]interface{}) (int64, error)

func (*RequestHttp) CreateRecord

func (r *RequestHttp) CreateRecord(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, record interface{}) (*structs.RecordID, error)

func (*RequestHttp) CreateRecordV2

func (r *RequestHttp) CreateRecordV2(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, record interface{}) (*structs.RecordID, error)

func (*RequestHttp) DeleteRecord

func (r *RequestHttp) DeleteRecord(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, recordID int64) error

func (*RequestHttp) DeleteRecordV2

func (r *RequestHttp) DeleteRecordV2(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, recordID int64) error

func (*RequestHttp) DownloadAvatar

func (r *RequestHttp) DownloadAvatar(ctx context.Context, appCtx *structs.AppCtx, imageID string) ([]byte, error)

func (*RequestHttp) DownloadFile

func (r *RequestHttp) DownloadFile(ctx context.Context, appCtx *structs.AppCtx, fileID string) ([]byte, error)

func (*RequestHttp) Execute

func (r *RequestHttp) Execute(ctx context.Context, appCtx *structs.AppCtx, APIName string, options *structs.ExecuteOptions) (invokeResult *structs.FlowExecuteResult, err error)

func (*RequestHttp) GetAllGlobalConfig added in v0.0.22

func (r *RequestHttp) GetAllGlobalConfig(ctx context.Context, appCtx *structs.AppCtx) (map[string]string, error)

GetAllGlobalConfig

func (*RequestHttp) GetAppAccessToken added in v0.0.23

func (r *RequestHttp) GetAppAccessToken(ctx context.Context, appCtx *structs.AppCtx, apiName string) (*structs.AppAccessToken, error)

func (*RequestHttp) GetApprovalInstance added in v0.0.32

func (r *RequestHttp) GetApprovalInstance(ctx context.Context, appCtx *structs.AppCtx, options *structs.GetApprovalInstanceOptions) (*structs.ApprovalInstance, error)

func (*RequestHttp) GetApprovalInstanceList added in v0.0.32

func (r *RequestHttp) GetApprovalInstanceList(ctx context.Context, appCtx *structs.AppCtx, options *structs.ApprovalInstanceListOptions) (approvalInstanceList *structs.ApprovalInstanceList, err error)

func (*RequestHttp) GetDefaultAppAccessToken added in v0.0.23

func (r *RequestHttp) GetDefaultAppAccessToken(ctx context.Context, appCtx *structs.AppCtx) (*structs.AppAccessToken, error)

func (*RequestHttp) GetDefaultTenantAccessToken added in v0.0.23

func (r *RequestHttp) GetDefaultTenantAccessToken(ctx context.Context, appCtx *structs.AppCtx) (*structs.TenantAccessToken, error)

func (*RequestHttp) GetExecutionInfo

func (r *RequestHttp) GetExecutionInfo(ctx context.Context, appCtx *structs.AppCtx, executionID int64) (instanceInfo *structs.ExecutionInfo, err error)

func (*RequestHttp) GetExecutionUserTaskInfo

func (r *RequestHttp) GetExecutionUserTaskInfo(ctx context.Context, appCtx *structs.AppCtx, executionID int64) (taskInfoList []*structs.TaskInfo, err error)

func (*RequestHttp) GetField

func (r *RequestHttp) GetField(ctx context.Context, appCtx *structs.AppCtx, objectAPIName, fieldAPIName string) (result *structs.Field, err error)

func (*RequestHttp) GetFields

func (r *RequestHttp) GetFields(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string) (result *structs.ObjFields, err error)

func (*RequestHttp) GetRecordCount

func (r *RequestHttp) GetRecordCount(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, param *structs.GetRecordsReqParam) (int64, error)

func (*RequestHttp) GetRecordCountV2

func (r *RequestHttp) GetRecordCountV2(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, param *structs.GetRecordsReqParamV2) (int64, error)

func (*RequestHttp) GetRecords

func (r *RequestHttp) GetRecords(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, param *structs.GetRecordsReqParam, records interface{}) ([][]string, error)

func (*RequestHttp) GetRecordsV2

func (r *RequestHttp) GetRecordsV2(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, param *structs.GetRecordsReqParamV2, records interface{}) ([][]string, error)

func (*RequestHttp) GetTenantAccessToken added in v0.0.23

func (r *RequestHttp) GetTenantAccessToken(ctx context.Context, appCtx *structs.AppCtx, apiName string) (*structs.TenantAccessToken, error)

func (*RequestHttp) GetTenantInfo

func (r *RequestHttp) GetTenantInfo(ctx context.Context, appCtx *structs.AppCtx) (*cStructs.Tenant, error)

func (*RequestHttp) InvokeFunctionAsync

func (r *RequestHttp) InvokeFunctionAsync(ctx context.Context, appCtx *structs.AppCtx, apiName string, params map[string]interface{}) (int64, error)

func (*RequestHttp) InvokeFunctionWithAuth

func (r *RequestHttp) InvokeFunctionWithAuth(ctx context.Context, appCtx *structs.AppCtx, apiName string, params interface{}, result interface{}) error

func (*RequestHttp) MGetUserSettings

func (r *RequestHttp) MGetUserSettings(ctx context.Context, appCtx *structs.AppCtx, userIDList []int64) (result []*structs.Locale, err error)

func (*RequestHttp) Oql

func (r *RequestHttp) Oql(ctx context.Context, appCtx *structs.AppCtx, oql string, args interface{}, namedArgs map[string]interface{}, records interface{}) (unauthFields [][]string, err error)

func (*RequestHttp) RevokeExecution

func (r *RequestHttp) RevokeExecution(ctx context.Context, appCtx *structs.AppCtx, executionID int64, options *structs.RevokeOptions) error

func (*RequestHttp) Transaction

func (r *RequestHttp) Transaction(ctx context.Context, appCtx *structs.AppCtx, placeholders map[string]int64, operations []*structs.TransactionOperation) (map[string]int64, error)

func (*RequestHttp) UpdateMessage

func (r *RequestHttp) UpdateMessage(ctx context.Context, appCtx *structs.AppCtx, param map[string]interface{}) error

func (*RequestHttp) UpdateRecord

func (r *RequestHttp) UpdateRecord(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, recordID int64, record interface{}) error

func (*RequestHttp) UpdateRecordV2

func (r *RequestHttp) UpdateRecordV2(ctx context.Context, appCtx *structs.AppCtx, objectAPIName string, recordID int64, record interface{}) error

func (*RequestHttp) UploadAvatar

func (r *RequestHttp) UploadAvatar(ctx context.Context, appCtx *structs.AppCtx, fileName string, fileReader io.Reader) (*structs.Avatar, error)

func (*RequestHttp) UploadFile

func (r *RequestHttp) UploadFile(ctx context.Context, appCtx *structs.AppCtx, fileName string, fileReader io.Reader, expireSeconds time.Duration) (*structs.Attachment, error)

func (*RequestHttp) UploadFileV2

func (r *RequestHttp) UploadFileV2(ctx context.Context, appCtx *structs.AppCtx, fileName string, fileReader io.Reader) (*structs.FileUploadResult, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL