APIV2 CRUD Activities
- Marc Probst
- Andreas Marinello
- Silvan Grüter
Introduction
Based on the CoreOne Application Program Interface V2 (API-V2) there are CRUD activities for each entity.
Class Name on this pages referres to the type of an activity as shown in the workflow builder.
For example:
The Class Name of this activity is GetCoreIdentityByIdActivity.
Get Activity
The get activity loads the entity based on its identifier and returns a JSON object with the requested properties.
Activity Name: <EntityName> Get
Input Data
The following input data can be configured for the activity.
Entity Id
The identifier of the entity,
Required Properties
A list of properties to load can be the snake-cased properties names of the entity itself or the system names of attributes you want to load.
Output Data
The result will be stored in the property ApiObject.
Available Activities
Entity Type | Activity Name | Class Name | Version |
|---|---|---|---|
Asset | Asset Get | GetAssetByIdActivity | 8.0 |
Attribute | Attribute Get | GetAttributeByIdActivity | 8.0 |
Certification | Certification Get | GetCertificationByIdActivity | 8.0 |
CertificationEntry | CertificationEntry Get | GetCertificationEntryByIdActivity | 8.0 |
CoreIdentity | CoreIdentity Get | GetCoreIdentityByIdActivity | 8.0 |
CoreIdentityRepresentation | CoreIdentityRepresentation Get | GetCoreIdentityRepresentationByIdActivity | 8.0 |
EmploymentType | EmploymentType Get | GetEmploymentTypeByIdActivity | 8.0 |
Identity | Identity Get | GetIdentityByIdActivity | 8.0 |
OrganizationUnit | OrganizationUnit Get | GetOrganizationUnitByIdActivity | 8.0 |
OrganizationUnitRecord | OrganizationUnitRecord Get | GetOrganizationUnitRecordByIdActivity | 8.0 |
Resource | Resource Get | GetResourceByIdActivity | 8.0 |
ResourceAssignment | ResourceAssignment Get | GetResourceAssignmentByIdActivity | 8.2.5 |
ResourceAssignmentContext | ResourceAssignmentContext Get | GetResourceAssignmentContextByIdActivity | 8.2.5 |
Get All Activity
The get activity loads a list of entities that can be filtered and sorted based on the API-V2 REST Querystring-Parameter
Activity Name: <EntityName> Get All
Input Data
The following input data can be configured for the activity.
Properties
A list of snake-cased properties to load.
Attribute
A list of attribute system names to load.
Query String
The query string that follows the guideline API-V2 REST Querystring-Parameter.
Output Data
The result will be stored in the property ApiObjects.
Available Activities
Entity Type | Activity Name | Class Name | Version |
|---|---|---|---|
CoreIdentity | CoreIdentity Get All | GetAllCoreIdentityActivity | 8.1 |
Identity | Identity Get All | GetIAlldentityActivity | 8.1 |
Attribute | Attribute Get All | GetAllAttributeActivity | 8.1 |
OrganizationUnit | OrganizationUnit Get All | GetAllCertificationEntryActivity | 8.1 |
CoreIdentityRepresentation | CoreIdentityRepresentation Get All | GetAllCoreIdentityRepresentationActivity | 8.1 |
OrganizationUnitRecord | OrganizationUnitRecord Get All | GetAllOrganizationUnitRecordActivity | 8.1 |
EmploymentType | EmploymentType Get All | GetAllEmploymentTypeActivity | 8.1 |
CertificationEntry | CertificationEntry Get All | GetAllCertificationEntryActivity | 8.1 |
Certification | Certification Get All | GetAllCertificationActivity | 8.1 |
Asset | Asset Get All | GetAllAssetActivity | 8.1 |
Resource | Resource Get All | GetAllResourceActivity | 8.1 |
ResourceAssignmentContext | ResourceAssignmentContext All | GetAllResourceAssignmentActivity | 8.2.5 |
ResourceAssignment | ResourceAssignment All | GetAllResourceAssignmentContextActivity | 8.2.5 |
Create Activity
This activity creates an object and returns the identifier of the newly created entity.
Activity Name: <EntityName> Create
Input Data
The following input data can be configured for the activity.
Input Object
The properties of the entity to create as JSON based on the guideline API-V2 REST Create objects | Create a single object.
Available Activities
Entity Type | Activity Name | Class Name | Version |
|---|---|---|---|
CoreIdentity | CoreIdentity Create | CreateCoreIdentityActivity | 8.0 |
Identity | Identity Create | CreateIdentityActivity | 8.0 |
OrganizationUnit | OrganizationUnit Create | CreateOrganizationUnitActivity | 8.0 |
CoreIdentityEmployment | CoreIdentityEmployment | CreateCoreIdentityEmploymentActivity | 8.0 |
CoreIdentityRepresentation | CoreIdentityRepresentation Create | CreateCoreIdentityRepresentationActivity | 8.0 |
CoreIdentityRepresentationStateEvent | CoreIdentityRepresentationStateEvent | CreateCoreIdentityRepresentationStateEventActivity | 8.0 |
OrganizationUnitRecord | OrganizationUnitRecord Create | CreateOrganizationUnitRecordActivity | 8.0 |
CoreIdentityRepresentationRelationshipStateEv | CoreIdentityRepresentationRelationshipStateEv | CreateCoreIdentityRepresentationRelationshipStateEvActivity | 8.0 |
CertificationEntry | CertificationEntry Create | CreateCertificationEntryActivity | 8.0 |
Certification | Certification Create | CreateCertificationActivity | 8.0 |
Update Activity
Updates the entity based on the changes.
Activity Name: <EntityName> Update
Input Data
The following input data can be configured for the activity.
Entity Id
The identifier of the entity
Changes
The changes that have to be applied to the entity. The changes have to be in JSON and based on the guideline API-V2 REST Update objects | Update a single object
Available Activities
Entity Type | Activity Name |
| Version |
|---|---|---|---|
CoreIdentity | CoreIdentity Update | UpdateCoreIdentityByIdActivity | 8.0 |
Identity | Identity Update | UpdateIdentityByIdActivity | 8.0 |
OrganizationUnit | OrganizationUnit Update | UpdateOrganizationUnitByIdActivity | 8.0 |
CoreIdentityRepresentation | CoreIdentityRepresentation Update | UpdateCoreIdentityRepresentationByIdActivity | 8.0 |
OrganizationUnitRecord | OrganizationUnitRecord Update | UpdateOrganizationUnitRecordByIdActivity | 8.0 |
CoreIdentityEmployment | CoreIdentityEmployment Update | UpdateCoreIdentityEmploymentByIdActivity | 8.0 |
Delete Activity
Deletes an entity based on its identifier.
Activity Name: <EntityName> Delete
Input Data
The following input data can be configured for the activity.
Entity Id
The identifier of the entity,
Available Activities
Entity Type | Activity Name | Class Name | Version |
|---|---|---|---|
CoreIdentity | CoreIdentity Delete | DeleteCoreIdentityByIdActivity | 8.0 |
Identity | Identity Delete | DeleteIdentityByIdActivity | 8.0 |
OrganizationUnit | OrganizationUnit Delete | DeleteOrganizationUnitByIdActivity | 8.0 |
CoreIdentityRepresentation | CoreIdentityRepresentation Delete | DeleteCoreIdentityRepresentationByIdActivity | 8.0 |
OrganizationUnitRecord | OrganizationUnitRecord Delete | DeleteOrganizationUnitRecordByIdActivity | 8.0 |
© ITSENSE AG. Alle Rechte vorbehalten. ITSENSE und CoreOne sind eingetragene Marken der ITSENSE AG.