> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Project Event Entity From Project Id > Get a ProjectEventEntity based on a projectId. NsApiSlow threshold: 2000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-ProjectAgent.json post /api/v1/Agents/Project/GetProjectEventEntityFromProjectId openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - ProjectAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/Project/GetProjectEventEntityFromProjectId: post: tags: - Project_Agent summary: Get Project Event Entity From Project Id description: |- Get a ProjectEventEntity based on a projectId. NsApiSlow threshold: 2000 ms. operationId: v1ProjectAgent_GetProjectEventEntityFromProjectId parameters: - name: $select in: query description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ProjectCarriers.GetProjectEventEntityFromProjectIdRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ProjectCarriers.GetProjectEventEntityFromProjectIdRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ProjectCarriers.GetProjectEventEntityFromProjectIdRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ProjectCarriers.GetProjectEventEntityFromProjectIdRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ProjectCarriers.GetProjectEventEntityFromProjectIdRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ProjectCarriers.GetProjectEventEntityFromProjectIdRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ProjectCarriers.GetProjectEventEntityFromProjectIdRequest description: ProjectId required: true responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ProjectEventEntity text/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ProjectEventEntity application/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ProjectEventEntity text/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ProjectEventEntity application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ProjectEventEntity application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ProjectEventEntity security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.ProjectCarriers.GetProjectEventEntityFromProjectIdRequest: description: >- GetProjectEventEntityFromProjectId: Get a ProjectEventEntity based on a projectId. type: object properties: ProjectId: format: int32 type: integer SuperOffice.CRM.Services.ProjectEventEntity: description: "The ProjectEvent Service. The service implements all services working with the ProjectEvent object\r\n\r\nCarrier object for ProjectEventEntity.\r\nServices for the ProjectEventEntity Carrier is available from the Project Agent." type: object properties: SignOffConfirmationText: description: Text shown as confirmation text before accepting sign off. type: string SignOffText: description: Default text for the activity created when signing off. type: string SignOnConfirmationText: description: Text shown as confirmation text before accepting sign on. type: string SignOnText: description: Default text for the activity created when signing on. type: string EventDate: format: date-time description: >- Dateof the event; publishing/visibility dates are in Publish, and restrictions are in AudienceVisibility type: string Enabled: description: Is the event enabled type: boolean CreatedDate: format: date-time description: Registered when in UTC. type: string SignOff: description: Is Sign Off functionality enabled? type: boolean SignOffTaskEnable: description: >- If not 0, a task should be created when the external user Signs Off an event type: boolean SignOffTaskId: format: int32 description: >- If not 0, sign off should cause an Activity of this type to be registered type: integer SignOffTriggersAssign: description: >- If 1, the SignOff task should be created as an Assigned task, triggering the invitation dialog type: boolean SignOn: description: Is Sign On functionality enabled type: boolean SignOnTaskEnable: description: >- If not 0, a task should be created when the external user Signs On to an event type: boolean SignOnTaskId: format: int32 description: >- If not 0, sign on should cause an Activity of this type to be registered type: integer SignOnTriggersAssign: description: >- If 1, the SignOn task should be created as an Assigned task, triggering the invitation dialog type: boolean UpdatedDate: format: date-time description: Last updated when in UTC. type: string CreatedBy: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' UpdatedBy: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' ProjectId: format: int32 description: The projectId for the project this projectEvent belongs to type: integer Id: format: int32 description: Id of the external event type: integer PublishFrom: format: date-time description: Publication valid from (inclusive) type: string PublishType: description: Type of publishing action, 0 = Unknown, 1 = to external persons enum: - Undefined - External type: string PublishTo: format: date-time description: Publication valid to (inclusive) type: string VisibleForCategories: description: >- Array of categories that the event is visible for. MDO Table "category". type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' VisibleForPersonInterests: description: >- Array of person interests (MDO table "persint") that this event is visible for. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' IsPublished: description: >- Publish to external users? When true, the event/project information is visible to external users through the Audience portal. You can control the publish duration using the PublishFrom/PublishTo properties. type: boolean IsVisibleForMembers: description: '' type: boolean IsVisibleForCategories: description: '' type: boolean IsVisibleForPersonInterests: description: '' type: boolean ProjectEventId: format: int32 description: Primary key type: integer TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Associate: description: "Carrier object for Associate.\r\nServices for the Associate Carrier is available from the Associate Agent." type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\nUse MDO List name \"person\" to get list items." type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string ExtraFields: description: "Deprecated: Use {SuperOffice.CRM.Services.Associate.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc." type: object additionalProperties: type: string CustomFields: description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.Associate.ExtraFields} and UserDefinedFields properties are deprecated in favor of this\r\ncombined collection." type: object additionalProperties: type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.MDOListItem: description: "Carrier object for MDOListItem.\r\nServices for the MDOListItem Carrier is available from the MDO Agent." type: object properties: Id: format: int32 description: The Id of the ListItem type: integer Name: description: The name of the ListItem type: string ToolTip: description: The tooltip of the ListItem type: string Deleted: description: The deleted status of the ListItem type: boolean Rank: format: int32 description: The rank of the ListItem type: integer Type: description: The type of the ListItem. Custom field. type: string ChildItems: description: The child items of the MDOListItem type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' IconHint: description: The Icon hint of the ListItem. Custom field. type: string ColorBlock: format: int32 description: The color indicator of the ListItem color block type: integer ExtraInfo: description: >- Extra information added to the ListItem. Could be information such as sort order etc or other meta data. Custom field. type: string StyleHint: description: >- Style hint indicating, information such as background color etc. Custom field. type: string FullName: description: The name of the ListItem in its context type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [SuperOffice.WebApi.Data.Project GetProjectEventEntityFromProjectIdRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Project_GetProjectEventEntityFromProjectIdRequest.md) - [NSProjectAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSProjectAgent.md) - [SuperOffice.WebApi.Agents.ProjectAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ProjectAgent.md) - [SuperOffice.WebApi.Agents.IProjectAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IProjectAgent.md) - [NSProjectEventEntity](/en/automation/crmscript/reference/CRMScript.NetServer.NSProjectEventEntity.md) - [Get Project Event Entity](/en/api/reference/restful/agent/project_agent/get-project-event-entity.md)