NextGen APIs

Project Profiles (resource) Technical Analysis

:warning:

Keep this page visibility restricted to:

  • Next-Gen FSM APIs admin

  • fsm developers

  • csg technical analyst involved in the Next-Gen FSM APIs - Private API Suite documentation

  • csg developers involved in the Next-Gen FSM APIs - Private API Suite development

Table name

APROJECTPROFILE

Edit the link to address the page containing the table definition in the “Next-Gen FSM Platform Tech. Doc.” portal.

Namespace

overit.xxx.xxx.xxx.xxx.xxx.BOxxx

:info:

Namespace or package. Developers are responsible for defining this field.

Domain Object

BOxxx

:info:

Name of the class defining the REST resource. Developers are responsible for defining this field.

Attributes

Domain Attribute Name

REST Object Attribute

Type

DB Field Name

Description

Not Null

Read Only

Default Value

Linked Entity

Notes

:info:

Developers are responsible for defining this field.

id

Number

APROID

Project Profile ID

Yes or empty

Yes or empty


Fill with the REST resource name, if applicable, not the database table name.

:info:

Developers can modify adding a link to the Technical Analysis page



code

String

APROCODE

Project Profile code







description

String

APRODESCRIPTION

Project Profile description







defaultStartTime

Date

APROSTARTDATE

Default start time







defaultEndTime

Date

APROENDDATE

Default end time







minutesPerDay

Number

APROMINDAY

Minutes per day







hoursPerWeek

Number

APROHOURWEEK

Hours per week







daysPerMonth

Number

APRODAYMONTH

Days per month







activityPrefix

String

APROACTIVITYPREFIX

Project Activity prefix







activityStartDateId

Number

APROID_LPAS

Project Activity start date id




Project Activity Start Dates



activityPriority

Number

APROACTIVITYPRIORITY

Project Activity end date







duration

value: Number
calendarUnit: Number

value: APROACTIVITYDURATION
calendarUnit: APROIDACTDUR_LCUN

Estimated duration







effort

value: Number
calendarUnit: Number

value: APROACTIVITYEFFORT
calendarUnit: APROIDACTEFF_LCUN

Estimated effort







defaultProjectUserStatusId

Number

APROID_TPUS

Default project user status id




Project User Statuses



defaultActivityUserStatusId

Number

APROID_TPAU

Default project activity user status id




Project Activity User Statuses



default

Boolean

APROISDEFAULT

Project Profile default flag







active

Boolean

APROISACTIVE

Project Profile active flag







associatedCalendarId

Number

APROID_ATRC

Associated Calendar id




Calendars



effortInMinutes

Number

APROMINDAY

Minimun effort in minutes







projectProfileId

Number

APROID

Project Profile ID







Values

Applicable only to entities representing predefined types.

Id

Description



Technical details

When returning results in GET api (GET /work-orders/projects/r1/project-profiles ) we must return only results with APROID_APRJ IS NULL.