Serializers

Serializers Fields

Available fields to be used in serializers

SharePointPropertyField

class sharepoint_rest_api.serializers.fields.SharePointPropertyField(**kwargs)

Get attribute from the object or properties converting it to camlcase e.g. from_date –> fromDate

UpperSharePointPropertyField

class sharepoint_rest_api.serializers.fields.UpperSharePointPropertyField(**kwargs)

Get attribute from the object or properties, it changes to upper case e.g uuid –> UUID

SharePointPropertyManyField

class sharepoint_rest_api.serializers.fields.SharePointPropertyManyField(**kwargs)

Get attribute from the object or properties, handles multivalues

RawSearchSharePointField

class sharepoint_rest_api.serializers.fields.RawSearchSharePointField(**kwargs)

Gets the name of the field without any transformation

SearchSharePointField

class sharepoint_rest_api.serializers.fields.SearchSharePointField(**kwargs)

Gets the name of the field transforming the name with caml query function e.g. last_name -> LastName

CapitalizeSearchSharePointField

class sharepoint_rest_api.serializers.fields.CapitalizeSearchSharePointField(**kwargs)

Gets the name of the field capitalizing the name of the field e.g. example -> Example

Model Serializers Fields

Serializers for SharePoint models

SharePointTenantSerializer

class sharepoint_rest_api.serializers.model_serializers.SharePointTenantSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Serializer for SharePointTenant model

SharePointSiteSerializer

class sharepoint_rest_api.serializers.model_serializers.SharePointSiteSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Serializer for SharePointSite model

SharePointLibrarySerializer

class sharepoint_rest_api.serializers.model_serializers.SharePointLibrarySerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Serializer for Sharepoint Library model

Sharepoint

Serializers used to unmarshal SharePoint responses

BaseSharePointItemSerializer

class sharepoint_rest_api.serializers.sharepoint.BaseSharePointItemSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Base Serializer for SharePointItem object

SharePointSettingsSerializer

class sharepoint_rest_api.serializers.sharepoint.SharePointSettingsSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Serializer for Settings Based implementation

SharePointUrlSerializer

class sharepoint_rest_api.serializers.sharepoint.SharePointUrlSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Serializer for Url Based implementation

SharePointFileSerializer

class sharepoint_rest_api.serializers.sharepoint.SharePointFileSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Serializer for SharePoint File object