companyOidAliases
📖 Lists existing ObjectID aliases within the company for given ObjectType.
🔭 Required scope: read:company_configuration.
type Query {companyOidAliases(input: CompanyOIDAliasesInput}
⬆️ Interactive type overview. Click type names or +/- buttons to expand/collapse definitions.
Related Types Schema
📜 Partial schema that includes all types used in this operation.
input CompanyOIDAliasesInput {
"""Object type to get the aliases for"""
objectType: ObjectType!
"""Additional filters to narrow down the results"""
filterByOids: [String!]
filterByAliases: [String!]
"""Pagination page. Dafault value is 1"""
page: Int = 1
"""Number of items per page. Dafault value is 100 and maximum is 1000"""
perPage: Int = 100
}
enum ObjectType {
BOARD
JOB
JOB_ROLE
CREW_JOB
JOB_GROUP
JOB_LABEL
MULTI_DAY_JOB
BOARD_PUBLISH
USER
PROFILE
DATA_TYPE
DATA_TYPE_OPTION
CREW_TAG
PAYMENT_REPORT
CREW_NOTE
}
type CompanyOIDAliasesResponse {
"""Paginated list of returned aliases."""
paginatedList: [CompanyOidAlias!]!
"""Pagination pager with total count and current page"""
pager: Pager
}
type CompanyOidAlias {
id: String!
alias: String!
}
"""A pagination Pager"""
type Pager {
"""Current pagination page"""
currentPage: Int!
"""Total number of pagination pages"""
pageCount: Int!
"""Maximum number of records per pagination page"""
perPage: Int!
"""Total number of records"""
totalCount: Int!
}
"""
The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
"""
scalar Int
"""
The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
"""
scalar String