🔍 Code Extractor

class JobEntityData

Maturity: 29

JobEntityData is a SharePoint entity class representing job data in the SharePoint Online Onboarding REST Service.

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/onboarding/job_entity_data.py
Lines:
4 - 9
Complexity:
simple

Purpose

This class serves as a data model for job entities within SharePoint's onboarding REST service. It inherits from the Entity base class and provides type identification through the entity_type_name property. This class is used to interact with job-related data in SharePoint Online through the REST API, allowing for operations like querying, creating, updating, or deleting job entities in the SharePoint onboarding system.

Source Code

class JobEntityData(Entity):
    """"""

    @property
    def entity_type_name(self):
        return "Microsoft.Online.SharePoint.Onboarding.RestService.JobEntityData"

Parameters

Name Type Default Kind
bases Entity -

Parameter Details

__init__: The constructor parameters are inherited from the Entity base class. Typically, Entity classes in the office365 library accept a context parameter for API communication and optional property values for initialization.

Return Value

Instantiation returns a JobEntityData object that represents a SharePoint job entity. The entity_type_name property returns a string identifying the full type name in the SharePoint REST service: 'Microsoft.Online.SharePoint.Onboarding.RestService.JobEntityData'.

Class Interface

Methods

@property entity_type_name(self) -> str property

Purpose: Returns the fully qualified type name of this entity as recognized by the SharePoint REST service

Returns: String containing 'Microsoft.Online.SharePoint.Onboarding.RestService.JobEntityData', which identifies this entity type in SharePoint's type system

Attributes

Name Type Description Scope
entity_type_name str Read-only property that returns the SharePoint REST service type identifier for job entity data instance

Dependencies

  • office365-rest-python-client

Required Imports

from office365.sharepoint.entity import Entity
from office365.sharepoint.onboarding.job_entity_data import JobEntityData

Usage Example

from office365.sharepoint.client_context import ClientContext
from office365.sharepoint.onboarding.job_entity_data import JobEntityData
from office365.runtime.auth.user_credential import UserCredential

# Setup authentication
site_url = 'https://yourtenant.sharepoint.com/sites/yoursite'
username = 'user@yourtenant.onmicrosoft.com'
password = 'yourpassword'

# Create context
ctx = ClientContext(site_url).with_credentials(UserCredential(username, password))

# Instantiate JobEntityData (typically retrieved from SharePoint, not directly instantiated)
job_entity = JobEntityData(ctx)

# Access entity type name
print(job_entity.entity_type_name)
# Output: Microsoft.Online.SharePoint.Onboarding.RestService.JobEntityData

# Typically used in queries or operations
# job_entities = ctx.web.lists.get_by_title('Jobs').items.get().execute_query()
# for job in job_entities:
#     if isinstance(job, JobEntityData):
#         print(job.entity_type_name)

Best Practices

  • This class is typically not instantiated directly by users but rather returned from SharePoint REST API queries
  • Always use a properly configured ClientContext when working with SharePoint entities
  • The entity_type_name property is primarily used internally by the office365 library for type resolution and serialization
  • Ensure proper authentication is configured before attempting to work with SharePoint entities
  • This class inherits all methods and properties from the Entity base class, including properties, get_property(), set_property(), and execute_query() patterns
  • Use this class in conjunction with SharePoint list operations and queries to work with job-related data in the onboarding service

Tags

sharepoint entity job onboarding rest-api data-model office365

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class MigrationTaskEntityData 71.2% similar

    A SharePoint entity class representing migration task data in the SharePoint Migration Center.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/migrationcenter/common/task_entity_data.py

  • class MigrationTask 69.4% similar

    A class representing a SharePoint migration task entity that extends MigrationTaskEntityData and provides entity type identification.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/migrationcenter/common/task.py

  • class SPMachineLearningModelEntityData 64.8% similar

    A SharePoint entity class representing machine learning model data in the Content Center, inheriting from the base Entity class.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/contentcenter/machinelearning/models/entity_data.py

  • class SPMachineLearningSampleEntityData 64.0% similar

    A SharePoint entity class representing machine learning sample entity data within the Content Center service.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/contentcenter/machinelearning/samples/entity_data.py

  • class Entity 63.8% similar

    Base class for SharePoint entities that provides common operations like create, read, update, and delete (CRUD) functionality for SharePoint objects.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/entity.py
← Back to Browse