View an RFI by Code
get
/primeapi/restapi/rfi/workspace/{workspaceCode}/project/{projCode}/code/{rfiCode}
This endpoint returns RFIs that meet the following requirements:
- The object has a code that matches the value of the {code} path parameter.
Request
Path Parameters
-
projCode: string
The user-specified identifier of a project.
-
rfiCode: string
The user-specified identifier of an RFI.
-
workspaceCode: string
The user-specified identifier of a workspace.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityRfi
Type:
Show Source
object
-
answer(optional):
string
Read Only:
true
The answer for the RFI. -
areaTree(optional):
string
The area associated with the RFI.
-
assignToUser(optional):
integer(int64)
The user who is responsible to take the action.
-
assignToUserName(optional):
string
The username of the user that is assigned to the RFI.
-
ballInCourt(optional):
integer(int64)
The user who is currently responsible for the RFI. User actions determine the Ball in Court user.
-
ballInCourtUserName(optional):
string
The username of the user that must respond to the RFI.
-
codeValuesRfi(optional):
array codeValuesRfi
Unique Items Required:
true
The categories assigned to an RFI. -
commentAction(optional):
string
Read Only:
true
Allowed Values:[ "REPLY", "FORWARD", "REOPEN", "SAVE", "SUBMIT", "CLOSED", "DIRECT_SUBMIT", "POST_COMMENT" ]
The type of a comment. -
companyName(optional):
string
The name of a company.
-
companyPostalCode(optional):
string
The postal code associated with a company.
-
coordinatorUser(optional):
integer(int64)
The system-generated identifier of a user.
-
coordinatorUserName(optional):
string
The username of the user assigned as coordinator of the RFI.
-
costImpact(optional):
string
Allowed Values:
[ "YES", "NO", "UNKNOWN" ]
Specifies whether the subject of the RFI impacts the cost of the project. Values include Yes, No, and Unknown. -
dateClosed(optional):
object TimezoneSensitiveDateTime
-
discussion(optional):
object ApiEntityDiscussion
-
drawingRef(optional):
string
The name of a drawing associated with the RFI.
-
dueDate(optional):
string(date-time)
The date by which the RFI should be resolved.
-
initiatedByUser(optional):
integer(int64)
Read Only:
true
The user who created the RFI. -
initiatedByUserName(optional):
string
The username of the user that initiated the RFI.
-
initiatedDate(optional):
object TimezoneSensitiveDateTime
-
itemCode(optional):
string
A unique identifier for the RFI.
-
itemTree(optional):
string
The item associated with the RFI.
-
link(optional):
string(url)
Read Only:
true
-
notificationUsers(optional):
array notificationUsers
A list of users receiving notifications about the RFI.
-
owner(optional):
integer(int64)
The owner of the RFI.
-
ownerName(optional):
string
The username of the owner of the RFI.
-
priority(optional):
string
Allowed Values:
[ "LOW", "NORMAL", "HIGH", "URGENT" ]
The importance of the RFI. Values include Normal, Low, High, and Urgent. -
projectCode(optional):
string
The user-specified identifier of a project.
-
projectCompanyId(optional):
integer(int64)
The company responsible for the work associated with the RFI
-
projectId:
integer(int64)
The system-generated identifier of a project.
-
responsiblePersonId(optional):
integer(int64)
The contractor responsible for the work associated with the RFI.
-
responsiblePersonUserName(optional):
string
The username of the user assigned as responsible for the RFI.
-
rfiConfiguredFields(optional):
object ApiEntityRfiConfiguredFields
-
rfiId(optional):
integer(int64)
A unique identifier for the RFI.
-
rfiName:
string
The name of the RFI record.
-
rfiQuestion:
string
The question of the RFI.
-
scheduleImpact(optional):
string
Allowed Values:
[ "YES", "NO", "UNKNOWN" ]
Specifies whether the subject of the RFI impacts the project schedule. Values include Yes, No, and Unknown. -
specSectionId(optional):
integer(int64)
The project specification section associated with the RFI.
-
specSectionNumber(optional):
string
The number of the spec section the RFI belongs to.
-
status(optional):
string
Allowed Values:
[ "DRAFT", "PENDING", "CLOSED", "UNPUBLISHED" ]
The current status of the RFI. Values include Draft, Pending, and Closed. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceCode(optional):
string
The user-specified identifier of a workspace.
Nested Schema : codeValuesRfi
Type:
array
Unique Items Required:
true
The categories assigned to an RFI.
Show Source
Nested Schema : ApiEntityDiscussion
Type:
Show Source
object
-
applicationUserId:
integer(int64)
The user name of the user who submitted the discussion comment.
-
applicationUserName(optional):
string
The username of a user participating in a discussion.
-
comment:
string
The initial post that begins a discussion thread.
Discussions can take place on your projects, portfolios, and other object pages throughout the application. -
discussionDate(optional):
object TimezoneSensitiveDateTime
-
discussionId(optional):
integer(int64)
The system-generated identfier of a disscussion.
-
discussionScope(optional):
string
Allowed Values:
[ "PROJECT", "ACTIVITY", "SCOPE_ITEM", "SCOPE_ITEM_CHANGE_REQUEST", "SCOPE_ITEM_ASSIGNMENT", "CONTRACT", "COMMITMENT", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER_PROPOSAL", "WORK_PACKAGE", "WORK_PACKAGE_CHANGE_REQUEST", "CHANGE_REQUEST", "DOCUMENT", "DOC_ANNOTATION", "CAPITAL_PLAN", "SCENARIO", "RESOURCE_SCENARIO", "CAPITAL_PLAN_PROJECT", "PROJECT_FINANCIAL", "PROJECT_RESOURCE", "PROJECT_RISK", "GENERIC_PORTFOLIO", "STRATEGY", "BUDGET", "PROJECT_BUDGET", "PROJECT_BUDGET_CHANGES", "PROJECT_BUDGET_TRANSFERS", "PROJECT_ACTUALS", "WORK_MANAGER_TASK", "PROJECT_FUND", "WORKSPACE_FUND", "PORTFOLIO_FUND", "SUBMITTAL", "PAYMENT_APPLICATION", "IDEA", "RFI", "CHANGE_EVENT", "CHANGE_ESTIMATE", "CUSTOM_LOG_ITEM" ]
The type of object a discussion is associated with. -
foreignKeyId:
integer(int64)
The system-generated identifier of a reference.
-
link(optional):
string(url)
Read Only:
true
-
parentDiscussionId(optional):
integer(int64)
The system-generated identifier of a parent disscussion.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : notificationUsers
Type:
array
A list of users receiving notifications about the RFI.
Show Source
Nested Schema : ApiEntityRfiConfiguredFields
Type:
Show Source
object
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing cost fields in the form of key-value pairs.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing non-cost and non-text fields in the form of key-value pairs.
-
rfi(optional):
object ApiEntityRfi
-
rfiId(optional):
integer(int64)
A unique identifier for the RFI.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing text fields in the form of key-value pairs.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityCodeValueRfi
Type:
Show Source
object
-
codeType(optional):
object ApiEntityCodeType
-
codeValue(optional):
object ApiEntityCodeValue
-
codeValueId(optional):
integer(int64)
The system-generated identifier of a code value.
-
codeValueRfiId(optional):
integer(int64)
The system-generated identifier of an RFI.
-
link(optional):
string(url)
Read Only:
true
-
rfiId(optional):
integer(int64)
The system-generated identifier of an RFI.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityCodeType
Type:
Show Source
object
-
assignments(optional):
array assignments
Unique Items Required:
true
CodeType assignments. -
codeTypeCode:
string
Allowed Values:
[ "Length[1-40]" ]
This field displays the name of a code or value. -
codeTypeId(optional):
integer(int64)
The system-generated identifier of a code type.
-
codeTypeName:
string
Allowed Values:
[ "Length[1-40]" ]
The name of a code or value. -
link(optional):
string(url)
Read Only:
true
-
pushDownType:
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the workspace code. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspace:
integer(int64)
The ID of the owning workspace.
Nested Schema : ApiEntityCodeValue
Type:
Show Source
object
-
codeTypeId:
integer(int64)
The ID for the code type.
-
codeTypeName:
string
The name of a code or value.
-
codeValueCode:
string
Allowed Values:
[ "LENGTH[1-32]" ]
The unique identifier for the code value. -
codeValueId(optional):
integer(int64)
The unique identifier for the code value.
-
codeValueName:
string
Allowed Values:
[ "LENGTH[1-100]" ]
The name of the code value. -
link(optional):
string(url)
Read Only:
true
-
parentCodeValue(optional):
integer(int64)
The parent code value.
-
sequenceNumber:
integer(int32)
The number that specifies the position of the code value item within the code type list.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : assignments
Type:
array
Unique Items Required:
true
CodeType assignments.
Show Source
Nested Schema : ApiEntityCodeEntityType
Type:
Show Source
object
-
codeType:
object ApiEntityCodeType
-
entityType:
string
Allowed Values:
[ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "STRATEGY", "PORTFOLIO", "FUND", "SUBMITTAL", "CHANGE_ORDER", "PAYMENT_APPLICATION", "CHANGE_EVENT", "CHANGES_ESTIMATES", "IDEA", "RFI", "CUSTOM_LOG_ITEM" ]
Indicates the type of object the code is associated to. -
link(optional):
string(url)
Read Only:
true
-
primaryKey:
integer(int64)
The unique identifier of a code type table.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityRfiNotificationUsers
Type:
Show Source
object
-
applicationUserId:
integer(int64)
Users who will be notified of changes to the RFI.
-
applicationUserName(optional):
string
The username of a user receiving notifications.
-
link(optional):
string(url)
Read Only:
true
-
projectId:
integer(int64)
The system-generated identifier of a project.
-
rfiId:
integer(int64)
A unique identifier for the RFI.
-
rfiNotificationId(optional):
integer(int64)
A unique identifier for the RFI notification.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing cost fields in the form of key-value pairs.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing non-cost and non-text fields in the form of key-value pairs.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing text fields in the form of key-value pairs.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
404 Response
The requested object does not exist, or you do not have access to it.