Data Dictionary

Data Dictionary

This file lists all models (including auto-generated models), their fields, help text, and default values.

position

Model: Position_languages

Position_languages(id, position, qualification)

Field	Type	Unique	Default	Help Text
id	AutoField	False
position	ForeignKey	False		Related model: Position
qualification	ForeignKey	False		Related model: Qualification

Model: Position_classifications

Position_classifications(id, position, classification)

Field	Type	Unique	Default	Help Text
id	AutoField	False
position	ForeignKey	False		Related model: Position
classification	ForeignKey	False		Related model: Classification

Model: Position

The position model represents a job by combining different requirements, as well as geographic location

Field	Type	Unique	Default	Help Text
bid_statistics	ForeignKey	False		Related model: PositionBidStatistics
assignments	ForeignKey	False		Related model: Assignment
highlighted_by_org	ManyToManyField	False		Related model: Organization
favorited_by_users	ManyToManyField	False		Related model: UserProfile
bid_cycles	ManyToManyField	False		Related model: BidCycle
bid_cycle_statuses	ForeignKey	False		Related model: BiddingStatus
bids	ForeignKey	False		Related model: Bid
waivers	ForeignKey	False		Related model: Waiver
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
position_number	TextField	False		The position number
description	OneToOneField	False		Related model: CapsuleDescription
title	TextField	False		The position title
tour_of_duty	ForeignKey	False		Related model: TourOfDuty
current_assignment	ForeignKey	False		Related model: Assignment
grade	ForeignKey	False		Related model: Grade
skill	ForeignKey	False		Related model: Skill
organization	ForeignKey	False		Related model: Organization
bureau	ForeignKey	False		Related model: Organization
post	ForeignKey	False		Related model: Post
is_overseas	BooleanField	False	False	Flag designating whether the position is overseas
create_date	DateTimeField	False		The creation date of the position
update_date	DateTimeField	False		The update date of this position
effective_date	DateTimeField	False		The effective date of this position
posted_date	DateTimeField	False		The posted date of this position
_seq_num	TextField	False
_title_code	TextField	False
_org_code	TextField	False
_bureau_code	TextField	False
_skill_code	TextField	False
_staff_ptrn_skill_code	TextField	False
_pay_plan_code	TextField	False
_status_code	TextField	False
_service_type_code	TextField	False
_grade_code	TextField	False
_post_code	TextField	False
_language_1_code	TextField	False
_language_2_code	TextField	False
_location_code	TextField	False
_language_req_1_code	TextField	False
_language_req_2_code	TextField	False
_language_1_spoken_proficiency_code	TextField	False
_language_1_reading_proficiency_code	TextField	False
_language_2_spoken_proficiency_code	TextField	False
_language_2_reading_proficiency_code	TextField	False
_create_id	TextField	False
_update_id	TextField	False
_jobcode_code	TextField	False
_occ_series_code	TextField	False
languages	ManyToManyField	False		Related model: Qualification
classifications	ManyToManyField	False		Related model: Classification

Model: PositionBidStatistics

Stores the bid statistics on a per-cycle basis for a position

Field	Type	Unique	Default	Help Text
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
bidcycle	ForeignKey	False		Related model: BidCycle
position	ForeignKey	False		Related model: Position
total_bids	IntegerField	False	0
in_grade	IntegerField	False	0
at_skill	IntegerField	False	0
in_grade_at_skill	IntegerField	False	0

Model: CapsuleDescription

Represents a capsule description, describing the associated object in plain English

Field	Type	Unique	Default	Help Text
position	OneToOneField	False		Related model: Position
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
content	TextField	False
point_of_contact	TextField	False
website	TextField	False
last_editing_user	ForeignKey	False		Related model: UserProfile
date_created	DateTimeField	False
date_updated	DateTimeField	False
_pos_seq_num	TextField	False

Model: Grade

The grade model represents an individual job grade

Field	Type	Unique	Default	Help Text
positions	ForeignKey	False		Related model: Position
userprofile	ForeignKey	False		Related model: UserProfile
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
code	TextField	False
rank	IntegerField	False	0

Model: Skill

The skill model represents an individual job skill

Field	Type	Unique	Default	Help Text
positions	ForeignKey	False		Related model: Position
userprofile	ManyToManyField	False		Related model: UserProfile
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
code	TextField	False		4 character string code representation of the job skill
cone	ForeignKey	False		Related model: SkillCone
description	TextField	False		Text description of the job skill

Model: SkillCone

The skill cone represents a grouping of skills

Field	Type	Unique	Default	Help Text
skills	ForeignKey	False		Related model: Skill
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
name	TextField	False		The name of the skill cone
_id	TextField	False
_skill_codes	TextField	False

Model: Classification

The position classification model represents a position's classification. Maintained as a separate model to support limiting visibility.

Field	Type	Unique	Default	Help Text
positions	ManyToManyField	False		Related model: Position
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
code	TextField	False		The classification code
description	TextField	False		Text description of the classification

Model: Assignment

The assignment model represents a current or past assignment, linking together users, positions, tours of duty, and other assignment related data

Field	Type	Unique	Default	Help Text
current_for_position	ForeignKey	False		Related model: Position
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
status	TextField	False	pending
curtailment_reason	TextField	False
user	ForeignKey	False		Related model: UserProfile
position	ForeignKey	False		Related model: Position
tour_of_duty	ForeignKey	False		Related model: TourOfDuty
create_date	DateTimeField	False		The date the assignment was created
start_date	DateTimeField	False		The date the assignment started
estimated_end_date	DateTimeField	False		The estimated end date based upon tour of duty
end_date	DateTimeField	False		The date this position was completed or curtailed
bid_approval_date	DateTimeField	False		The date the bid for this assignment was approved
arrival_date	DateTimeField	False		The date the incumbent arrived at the position
service_duration	IntegerField	False		The duration of a completed assignment in months
update_date	DateTimeField	False
is_domestic	BooleanField	False	False	Indicates if this position is domestic
combined_differential	IntegerField	False	0	The combined differential (danger pay and differential) for this assignment
standard_tod_months	IntegerField	False	0	The standard tour of duty for the post at assignment creation

messaging

Model: Notification

This model represents an individual notification item

Field	Type	Unique	Default	Help Text
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
message	TextField	False		The message for the notification
owner	ForeignKey	False		Related model: UserProfile
tags	ArrayField	False	<class 'list'>	This notification's tags
is_read	BooleanField	False	False	Whether this notification has been read
date_created	DateTimeField	False
date_updated	DateTimeField	False

Model: Task

This model represents a task object.

Field	Type	Unique	Default	Help Text
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
owner	ForeignKey	False		Related model: UserProfile
priority	IntegerField	False	0
tags	ArrayField	False	<class 'list'>	This task's tags
title	TextField	False
content	TextField	False
date_created	DateTimeField	False
date_updated	DateTimeField	False
date_due	DateTimeField	False
date_completed	DateTimeField	False

Model: Sharable

This model represents a shared item from one user to another. The field sharable_model is the string representation of the model, for example 'position.Position', and the sharable_id is the integer representation of the autofield primary key for that model

Field	Type	Unique	Default	Help Text
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
sharing_user	ForeignKey	False		Related model: UserProfile
receiving_user	ForeignKey	False		Related model: UserProfile
sharable_id	IntegerField	False		The ID of the model instance for this sharable
sharable_model	TextField	False		The string of the model
is_read	BooleanField	False	False	Whether this sharable has been read
date_created	DateTimeField	False
date_updated	DateTimeField	False

user_profile

Model: UserProfile_language_qualifications

UserProfile_language_qualifications(id, userprofile, qualification)

Field	Type	Unique	Default	Help Text
id	AutoField	False
userprofile	ForeignKey	False		Related model: UserProfile
qualification	ForeignKey	False		Related model: Qualification

Model: UserProfile_skills

UserProfile_skills(id, userprofile, skill)

Field	Type	Unique	Default	Help Text
id	AutoField	False
userprofile	ForeignKey	False		Related model: UserProfile
skill	ForeignKey	False		Related model: Skill

Model: UserProfile_favorite_positions

UserProfile_favorite_positions(id, userprofile, position)

Field	Type	Unique	Default	Help Text
id	AutoField	False
userprofile	ForeignKey	False		Related model: UserProfile
position	ForeignKey	False		Related model: Position

Model: UserProfile

UserProfile(id, _string_representation, user, date_of_birth, mandatory_retirement_date, phone_number, cdo, grade, primary_nationality, secondary_nationality)

Field	Type	Unique	Default	Help Text
edited_capsule_descriptions	ForeignKey	False		Related model: CapsuleDescription
assignments	ForeignKey	False		Related model: Assignment
notifications	ForeignKey	False		Related model: Notification
tasks	ForeignKey	False		Related model: Task
sent_shares	ForeignKey	False		Related model: Sharable
received_shares	ForeignKey	False		Related model: Sharable
direct_reports	ForeignKey	False		Related model: UserProfile
saved_searches	ForeignKey	False		Related model: SavedSearch
status_surveys	ForeignKey	False		Related model: StatusSurvey
bid_statistics	ForeignKey	False		Related model: UserBidStatistics
bidlist	ForeignKey	False		Related model: Bid
reviewing_bids	ForeignKey	False		Related model: Bid
waivers	ForeignKey	False		Related model: Waiver
reviewed_waivers	ForeignKey	False		Related model: Waiver
edited_glossary	ForeignKey	False		Related model: GlossaryEntry
feedbackentry	ForeignKey	False		Related model: FeedbackEntry
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
user	OneToOneField	False		Related model: User
date_of_birth	DateTimeField	False
mandatory_retirement_date	DateTimeField	False
phone_number	TextField	False
cdo	ForeignKey	False		Related model: UserProfile
grade	ForeignKey	False		Related model: Grade
primary_nationality	ForeignKey	False		Related model: Country
secondary_nationality	ForeignKey	False		Related model: Country
language_qualifications	ManyToManyField	False		Related model: Qualification
skills	ManyToManyField	False		Related model: Skill
favorite_positions	ManyToManyField	False		Related model: Position

Model: SavedSearch

Represents a saved search.

Field	Type	Unique	Default	Help Text
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
owner	ForeignKey	False		Related model: UserProfile
name	TextField	False	Saved Search	The name of the saved search
endpoint	TextField	False		The endpoint for this search and filter
filters	JSONField	False	<class 'dict'>	JSON object containing filters representing the saved search
count	IntegerField	False	0	Current count of search results for this search
date_created	DateTimeField	False
date_updated	DateTimeField	False

language

Model: Language

The language model represents an individual language, such as English, French, et. al. It is typically linked together with a language proficiency to create a qualification, but is maintained as a separate model to facilitate filtering and logical separations.

Field	Type	Unique	Default	Help Text
qualifications	ForeignKey	False		Related model: Qualification
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
code	TextField	False		The code representation of the language
long_description	TextField	False		Long-format description of the language, typically the name
short_description	TextField	False		Short-format description of the language, typically the name
formal_description	TextField	False		The formal description of the language
effective_date	DateTimeField	False		The date after which the language is in effect

Model: Proficiency

The language proficiency represents a positions linguistic proficiency requirement, or the linguistic proficiency of an individual. These are typically not used as stand-alone instances, but are linked via the Language qualification model with a specific language.

Possible values: 0, 0+, 1, 1+, 2, 2+, 3, 3+, 4, 4+, 5; which represent increasing levels of fluency with a language F - for a "failed" state on a proficiency exam P - for a "passed" state on a proficiency exam X - for a "not taken" state on a proficiency exam

Field	Type	Unique	Default	Help Text
reading_qualifications	ForeignKey	False		Related model: Qualification
spoken_qualifications	ForeignKey	False		Related model: Qualification
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
code	TextField	False		The code representing the linguistic proficiency
description	TextField	False		Text describing the level of proficiency

Model: Qualification

The language qualification is defined by a combination of language proficiencies and a specific language. For example, German 2/2+, where the first numeral denotes the reading/writing proficiency, and the second numeral denotes the speaking/listening proficiency.

Field	Type	Unique	Default	Help Text
positions	ManyToManyField	False		Related model: Position
qualified_users	ManyToManyField	False		Related model: UserProfile
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
language	ForeignKey	False		Related model: Language
reading_proficiency	ForeignKey	False		Related model: Proficiency
spoken_proficiency	ForeignKey	False		Related model: Proficiency

organization

Model: Organization_highlighted_positions

Organization_highlighted_positions(id, organization, position)

Field	Type	Unique	Default	Help Text
id	AutoField	False
organization	ForeignKey	False		Related model: Organization
position	ForeignKey	False		Related model: Position

Model: Organization

The organization model represents a DoS organization, such as bureaus

Field	Type	Unique	Default	Help Text
organization_positions	ForeignKey	False		Related model: Position
bureau_positions	ForeignKey	False		Related model: Position
organizion_children	ForeignKey	False		Related model: Organization
bureau_children	ForeignKey	False		Related model: Organization
groups	ManyToManyField	False		Related model: OrganizationGroup
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
code	TextField	False		The organization code
long_description	TextField	False		Long-format description of the organization
short_description	TextField	False		Short-format description of the organization
location	ForeignKey	False		Related model: Location
is_bureau	BooleanField	False	False	Boolean indicator if this organization is a bureau
is_regional	BooleanField	False	False	Boolean indicator if this organization is regional
parent_organization	ForeignKey	False		Related model: Organization
bureau_organization	ForeignKey	False		Related model: Organization
_parent_organization_code	TextField	False		Organization Code of the parent Organization
_parent_bureau_code	TextField	False		Bureau Code of the parent parent Bureau
_location_code	TextField	False		The location code for this organization
highlighted_positions	ManyToManyField	False		Related model: Position

Model: OrganizationGroup_organizations

OrganizationGroup_organizations(id, organizationgroup, organization)

Field	Type	Unique	Default	Help Text
id	AutoField	False
organizationgroup	ForeignKey	False		Related model: OrganizationGroup
organization	ForeignKey	False		Related model: Organization

Model: OrganizationGroup

Represents a logical grouping of organizations

Field	Type	Unique	Default	Help Text
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
name	TextField	False		The description of the organization grouping
_org_codes	ArrayField	False	<class 'list'>
organizations	ManyToManyField	False		Related model: Organization

Model: TourOfDuty

Represents a tour of duty

Field	Type	Unique	Default	Help Text
positions	ForeignKey	False		Related model: Position
assignments	ForeignKey	False		Related model: Assignment
posts	ForeignKey	False		Related model: Post
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
code	TextField	False		The tour of duty code
long_description	TextField	False		Long-format description of the tour of duty
short_description	TextField	False		Short-format description of the tour of duty
months	IntegerField	False	0	The number of months for this tour of duty
is_active	BooleanField	False	False
_status	TextField	False

Model: Country

Represents a country

Field	Type	Unique	Default	Help Text
locations	ForeignKey	False		Related model: Location
primary_citizens	ForeignKey	False		Related model: UserProfile
secondary_citizens	ForeignKey	False		Related model: UserProfile
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
code	TextField	False		The unique country code
short_code	TextField	False		The 2-character country code
location_prefix	TextField	False		The 2-character location prefix
name	TextField	False		The name of the country
short_name	TextField	False		The short name of the country
obc_id	TextField	False		The OBC ID for this country

Model: Location

Represents a geographic location

Field	Type	Unique	Default	Help Text
organizations	ForeignKey	False		Related model: Organization
posts	ForeignKey	False		Related model: Post
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
code	TextField	False		The unique location code
city	TextField	False
state	TextField	False
country	ForeignKey	False		Related model: Country
_country	TextField	False

Model: Post

Represents a post and its related fields

Field	Type	Unique	Default	Help Text
positions	ForeignKey	False		Related model: Position
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
location	ForeignKey	False		Related model: Location
cost_of_living_adjustment	IntegerField	False	0	Cost of living adjustment number
differential_rate	IntegerField	False	0	Differential rate number
danger_pay	IntegerField	False	0	Danger pay number
rest_relaxation_point	TextField	False		Rest and relaxation point
has_consumable_allowance	BooleanField	False	False
has_service_needs_differential	BooleanField	False	False
obc_id	TextField	False		The OBC ID for this post
tour_of_duty	ForeignKey	False		Related model: TourOfDuty
_tod_code	TextField	False
_location_code	TextField	False

bidding

Model: BidCycle_positions

BidCycle_positions(id, bidcycle, position)

Field	Type	Unique	Default	Help Text
id	AutoField	False
bidcycle	ForeignKey	False		Related model: BidCycle
position	ForeignKey	False		Related model: Position

Model: BidCycle

The bid cycle model represents an individual bidding cycle

Field	Type	Unique	Default	Help Text
position_bid_statistics	ForeignKey	False		Related model: PositionBidStatistics
statuses	ForeignKey	False		Related model: BiddingStatus
status_surveys	ForeignKey	False		Related model: StatusSurvey
user_bid_statistics	ForeignKey	False		Related model: UserBidStatistics
bids	ForeignKey	False		Related model: Bid
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
name	TextField	False		The name of the bid cycle
cycle_start_date	DateTimeField	False		The start date for the bid cycle
cycle_deadline_date	DateTimeField	False		The deadline date for the bid cycle
cycle_end_date	DateTimeField	False		The end date for the bid cycle
active	BooleanField	False	False	Whether this bidcycle is active or not
_id	TextField	False
_positions_seq_nums	ArrayField	False	<class 'list'>
_category_code	TextField	False
positions	ManyToManyField	False		Related model: Position

Model: BiddingStatus

The status of the bid in a given bid cycle

Field	Type	Unique	Default	Help Text
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
bidcycle	ForeignKey	False		Related model: BidCycle
position	ForeignKey	False		Related model: Position
status_code	CharField	False	OP	Cycle status code
status	CharField	False	Open	Cycle status text

Model: StatusSurvey

The status survey model represents eligiblity status self-identification information on a per-bidcycle basis

Field	Type	Unique	Default	Help Text
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
user	ForeignKey	False		Related model: UserProfile
bidcycle	ForeignKey	False		Related model: BidCycle
is_differential_bidder	BooleanField	False	False
is_fairshare	BooleanField	False	False
is_six_eight	BooleanField	False	False

Model: UserBidStatistics

Stores bid statistics for any particular bidcycle for each user

Field	Type	Unique	Default	Help Text
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
bidcycle	ForeignKey	False		Related model: BidCycle
user	ForeignKey	False		Related model: UserProfile
draft	IntegerField	False	0
submitted	IntegerField	False	0
handshake_offered	IntegerField	False	0
handshake_accepted	IntegerField	False	0
handshake_declined	IntegerField	False	0
in_panel	IntegerField	False	0
approved	IntegerField	False	0
declined	IntegerField	False	0
closed	IntegerField	False	0

Model: Bid

The bid object represents an individual bid, the position, user, and process status

Field	Type	Unique	Default	Help Text
waivers	ForeignKey	False		Related model: Waiver
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
status	TextField	False	draft
draft_date	DateTimeField	False
submitted_date	DateTimeField	False		The date the bid was submitted
handshake_offered_date	DateTimeField	False		The date the handshake was offered
handshake_accepted_date	DateTimeField	False		The date the handshake was accepted
handshake_declined_date	DateTimeField	False		The date the handshake was declined
in_panel_date	DateTimeField	False		The date the bid was scheduled for panel
scheduled_panel_date	DateTimeField	False		The date of the paneling meeting
approved_date	DateTimeField	False		The date the bid was approved
declined_date	DateTimeField	False		The date the bid was declined
closed_date	DateTimeField	False		The date the bid was closed
bidcycle	ForeignKey	False		Related model: BidCycle
user	ForeignKey	False		Related model: UserProfile
position	ForeignKey	False		Related model: Position
is_priority	BooleanField	False	False	Flag indicating if this bid is the bidder's priority bid
panel_reschedule_count	IntegerField	False	0	The number of times this bid's panel date has been rescheduled
reviewer	ForeignKey	False		Related model: UserProfile
create_date	DateTimeField	False
update_date	DateTimeField	False

Model: Waiver

The waiver model represents an individual waiver for a particular facet of a bid's requirements

Field	Type	Unique	Default	Help Text
id	AutoField	False
_string_representation	TextField	False		The string representation of this object
category	TextField	False
type	TextField	False	full
status	TextField	False	requested
bid	ForeignKey	False		Related model: Bid
position	ForeignKey	False		Related model: Position
user	ForeignKey	False		Related model: UserProfile
reviewer	ForeignKey	False		Related model: UserProfile
description	TextField	False		Description of the waiver request
create_date	DateTimeField	False
update_date	DateTimeField	False

permission

glossary

Model: GlossaryEntry

Represents an individual entry in the glossary

Field	Type	Unique	Default	Help Text
id	AutoField	False
title	TextField	False
definition	TextField	False
link	TextField	False
last_editing_user	ForeignKey	False		Related model: UserProfile
date_created	DateTimeField	False
date_updated	DateTimeField	False
is_archived	BooleanField	False	False	Denotes if this glossary item is archived

integrations

Model: SynchronizationJob

Represents a synchronization job, consisting of a database model, WSDL commands, and timing.

Synchronization jobs are evaluated by the synchronize_data command, which should be called by the deployment environment's scheduling software (e.g. cron)

Field	Type	Unique	Default	Help Text
id	AutoField	False
last_synchronization	DateTimeField	False	1975-01-01T00:00:00Z	The last time this model was synchronized
next_synchronization	DateTimeField	False		The next synchronization event
delta_synchronization	IntegerField	False	86400	The time, in seconds, between synchronizations
running	BooleanField	False	False	Whether the synchronization job is currently running
talentmap_model	TextField	False		The talentmap model as a string; e.g. position.Position
priority	IntegerField	False	0	The job priority, higher numbers run later. Default 0
use_last_date_updated	BooleanField	False	False	Denotes if the job should only pull newest records

feedback

Model: FeedbackEntry

Represents an individual feedback item

Field	Type	Unique	Default	Help Text
id	AutoField	False
comments	TextField	False
user	ForeignKey	False		Related model: UserProfile
is_interested_in_helping	BooleanField	False	False
date_created	DateTimeField	False