Skip to main content

setOidAliases

📖 Creates/updates ObjectID aliases within the company.

🔭 Required scope: write:company_configuration.

type Mutation {
setOidAliases(
}

⬆️ Interactive type overview. Click type names or +/- buttons to expand/collapse definitions.

📜 Partial schema that includes all types used in this operation.

input SetOIDAliasesInput {
"""up to 100 aliases can be set in one operation"""
aliases: [SetOidAliasInput!]!
}

input SetOidAliasInput {
objectType: ObjectType!

"""oid or currentAlias must be set"""
oid: String
currentAlias: String
newAlias: String!
}

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 SetOIDAliasesResponse {
success: Boolean!

"""
Errors object has next structure:
{
[property: [String!]!]
}
"""
errors: Map
errorCodes: Map
}

"""The `Boolean` scalar type represents `true` or `false`."""
scalar Boolean

scalar Map

"""
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