OBJECT

Mutation

link GraphQL Schema definition

  • type Mutation {
  • # Given an id or a remote_id close an open Position
  • #
  • # Arguments
  • # id: nCore Id of the Position. If the argument 'remote_id' is
  • # provided, this argument is not needed
  • # remote_id: Id set by you in nCore and used in your system. If
  • # the argument 'id' is provided, this argument is ignored
  • closePosition(id: Int, remote_id: String): Position
  • # Given an id or a remote_id delete a Position in the Draft state
  • #
  • # Arguments
  • # id: nCore Id of the Position. If the argument 'remote_id' is
  • # provided, this argument is not needed
  • # remote_id: Id set by you in nCore and used in your system. If
  • # the argument 'id' is provided, this argument is ignored
  • deleteDraftPosition(id: Int, remote_id: String): Position Id
  • # Given a node_id or a node_remote_id and a template_id, create a new Position
  • # from the template
  • #
  • # Arguments
  • # node_id: nCore Id of the Node. If the argument 'node_remote_id'
  • # is provided, this argument is not needed
  • # node_remote_id: Id set by you in nCore and used in your system.
  • # If the argument 'node_id' is provided, this argument is ignored
  • # template_id: nCore Id of the Position Template to use
  • createDraftPositionFromPositionTemplate(
  • node_id: Int,
  • node_remote_id: String,
  • template_id: Int
  • ): Position
  • # Given a node_id or a node_remote_id and all the required fields, it create a new
  • # Position in the Draft state
  • #
  • # Arguments
  • # node_id: nCore Id of the Node to use. If the argument
  • # 'node_remote_id' is provided, this argument is not needed
  • # node_remote_id: Id set by you in nCore and used in your system.
  • # If the argument 'node_id' is provided, this argument is ignored
  • # title: Title of the position to create
  • # language_id: nCore Id of the Language to use
  • # pipeline_id: nCore Id of the Pipeline to use
  • # description: Description of the position. Can contain HTML tags
  • # country: Country code in ISO 3166-1 alpha-2
  • # opening_date: Date of the opening of the Position (Y-m-d)
  • # closing_date: Date of the closing of the Position (Y-m-d)
  • # sub_title: Subtitle of the position. Cannot contain HTML tags
  • # has_location: Indicate if the Position has a specific location
  • # of employment
  • # address: Address of the location of employment
  • # city: City of the location of employment
  • # province: Province of the location of employment
  • # latitude: Latitude of the location of employment
  • # longitude: Longitude of the location of employment
  • # remote_id: Id set by you in nCore and used in your system
  • createDraftPosition(
  • node_id: Int,
  • node_remote_id: String,
  • title: String!,
  • language_id: Int!,
  • pipeline_id: Int!,
  • description: String!,
  • country: String!,
  • opening_date: String!,
  • closing_date: String!,
  • sub_title: String,
  • has_location: Boolean,
  • address: String,
  • city: String,
  • province: String,
  • latitude: String,
  • longitude: String,
  • remote_id: String
  • ): Position
  • # Updates the value set in a Position Additional Info Field. In nCore they are the
  • # Internal Position Field Sets compiled in the first step of the creation of a
  • # Position
  • #
  • # Arguments
  • # position_id: nCore Id of the Position to use. If the argument
  • # 'position_remote_id' is provided, this argument is not needed
  • # position_remote_id: Id set by you in nCore and used in your
  • # system. If the argument 'position_id' is provided, this argument is Ignored
  • # additional_info_field_internal_name: Name of the additional
  • # info field to set. If the argument 'additional_info_field_custom_internal_name'
  • # is provided, this argument is not needed
  • # additional_info_field_custom_internal_name: Custom name of the
  • # additional info field to set. If the argument
  • # 'additional_info_field_internal_name' is provided, this argument is not needed
  • # additional_info_field_value: Value of the additional info field
  • # to set
  • setPositionAdditionalInfoField(
  • position_id: Int,
  • position_remote_id: String,
  • additional_info_field_internal_name: String,
  • additional_info_field_custom_internal_name: String,
  • additional_info_field_value: String!
  • ): Position
  • # Given a parent_node_id, adds a new Node
  • #
  • # Arguments
  • # name: Name of the Node to create
  • # parent_node_id: nCore Id of the Node to associate as a parent
  • # of the new Node
  • # is_active: Set if the newly created Node should be active or
  • # not
  • # private: Set if the newly created Node should be private or not
  • # remote_id: Id set by you in nCore and used in your system
  • addNode(
  • name: String!,
  • parent_node_id: Int!,
  • is_active: Boolean,
  • private: Boolean,
  • remote_id: String
  • ): Node
  • # Given an id or a remote_id, updates a Node
  • #
  • # Arguments
  • # id: nCore Id of the Node. If the argument 'remote_id' is
  • # provided, this argument is not needed
  • # remote_id: Id set by you in nCore and used in your system. If
  • # the argument 'id' is provided, this argument is ignored
  • # private: Set if the Node should be private or not
  • # new_remote_id: Update the remote id with a new one
  • editNode(id: Int, remote_id: String, private: Boolean, new_remote_id: String): Node
  • # Given an id or a remote_id, enable or disable a Node
  • #
  • # Arguments
  • # id: nCore Id of the Node. If the argument 'remote_id' is
  • # provided, this argument is not needed
  • # remote_id: Id set by you in nCore and used in your system. If
  • # the argument 'id' is provided, this argument is ignored
  • # is_active: Set if the Node should be active or not
  • enableNode(id: Int, remote_id: String, is_active: Boolean): Node
  • # Add a new User
  • #
  • # Arguments
  • # email: Email of the User to add
  • # role_id: nCore Id of the Role to associate to the User
  • # firstname: First Name of the User to add
  • # lastname: Last Name of the User to add
  • # node_ids: nCore Ids of the Nodes to associate to the added User
  • # remote_id: Id set by you in nCore and used in your system
  • # remote_username: Username used to access with a different
  • # Identity Provider
  • addUser(
  • email: String!,
  • role_id: Int!,
  • firstname: String!,
  • lastname: String!,
  • node_ids: [Int]!,
  • remote_id: String,
  • remote_username: String
  • ): User
  • # Given the id or the remote_id of the User, change the User's Role
  • #
  • # Arguments
  • # id: nCore Id of the User. If the argument 'remote_id' is
  • # provided, this argument is not needed
  • # remote_id: Id set by you in nCore and used in your system. If
  • # the argument 'id' is provided, this argument is ignored
  • # role_id: nCore Id of the Role to associate to the User
  • changeUserRole(id: Int, remote_id: String, role_id: Int!): User
  • # Given a user_id or a user_remote_id and a node_id or a node_remote_id, associate
  • # the User to the Node
  • #
  • # Arguments
  • # user_id: nCore Id of the User. If the argument
  • # 'user_remote_id' is provided, this argument is not needed
  • # user_remote_id: Id set by you in nCore and used in your system.
  • # If the argument 'user_id' is provided, this argument is ignored
  • # node_id: nCore Id of the Node to associate to the User. If the
  • # argument 'node_remote_id' is provided, this argument is not needed
  • # node_remote_id: Id set by you in nCore and used in your system.
  • # If the argument 'node_id' is provided, this argument is ignored
  • addNodeToUser(
  • user_id: Int,
  • user_remote_id: String,
  • node_id: Int,
  • node_remote_id: String
  • ): User
  • # Given an id or a remote_id, lock or unlock the User, allowing it to either enter
  • # (unlock) or not enter (lock) the platform
  • #
  • # Arguments
  • # id: nCore Id of the User. If the argument 'remote_id' is
  • # provided, this argument is not needed
  • # remote_id: Id set by you in nCore and used in your system. If
  • # the argument 'id' is provided, this argument is ignored
  • # lock: Set if the User is locked (cannot access) in nCore
  • handleUserAccess(id: Int, remote_id: String, lock: Boolean!): User
  • # Given a position_id or a position_remote_id, allows you to create a new
  • # Application. You can also set the value 'invite' to send an email to the
  • # Application to invite for the completion of the application process
  • #
  • # Arguments
  • # position_id: nCore Id of the Position. If the argument
  • # 'position_remote_id' is provided, this argument is not needed
  • # position_remote_id: Id set by you in nCore and used in your
  • # system. If the argument 'position_id' is provided, this argument is ignored
  • # name: First Name of the Application to create
  • # surname: Last Name of the Application to create
  • # email: Email of the Application to create
  • # remote_id: Id set by you in nCore and used in your system
  • # nation_code: National code of the phone number prefix (i.e.
  • # "+39 (Italy)")
  • # mobile_number: National code of the number prefix
  • # address: Address of the Application
  • # city: City of the Application
  • # zip: Zip Code of the Application
  • # province: Province of the Application
  • # country: Country code in ISO 3166-1 alpha-2
  • # latitude: Latitude of the Application
  • # longitude: Longitude of the Application
  • # cv_base_64: Base 64 of the Curriculum of the Application
  • # cv_name: Name of the Curriculum of theApplication
  • # invite: Send an email to the Application invinting it to
  • # complete the candidature
  • createApplication(
  • position_id: Int,
  • position_remote_id: String,
  • name: String!,
  • surname: String!,
  • email: String!,
  • remote_id: String,
  • nation_code: String,
  • mobile_number: String,
  • address: String,
  • city: String,
  • zip: String,
  • province: String,
  • country: String,
  • latitude: String,
  • longitude: String,
  • cv_base_64: String,
  • cv_name: String,
  • invite: Boolean
  • ): Application
  • # Given an application_id or application_remote_id update the value of one
  • # Application Field Input
  • #
  • # Arguments
  • # application_id: nCore Id of the Application. If the argument
  • # 'application_remote_id' is provided, this argument is not needed
  • # application_remote_id: Id set by you in nCore and used in your
  • # system. If the argument 'application_id' is provided, this argument is ignored
  • # position_field_canonical_name: Canonical name of the Position
  • # Field to update
  • # input: Value of the Position Field to update
  • updateApplicationFieldInput(
  • application_id: Int,
  • application_remote_id: String,
  • position_field_canonical_name: String!,
  • input: String!
  • ): ApplicationFieldInput
  • # Given an email, allows you to delete all of the Application with the email.
  • # Allows you to have a soft or a hard delete
  • #
  • # Arguments
  • # email: Complete email of the Applicant to delete
  • # soft: Indicate if it is a hard delete or a soft delete
  • deleteApplicant(email: String!, soft: Boolean): [Id]
  • # Given an id of the Additional Info Field allows to update the name and the
  • # choices
  • #
  • # Arguments
  • # id:
  • # name: Name for the Additional Info Field to set
  • # choices: Choices of the Additional Info Field. Accepts a JSON
  • # object with key/values and eventually grouping up to one level. The JSON object
  • # must be encoded as a string
  • updateAdditionalInfoField(
  • id: Int!,
  • name: String,
  • choices: String
  • ): AdditionalInfoField
  • # Given an id of the Field allows to update the name and the choices
  • #
  • # Arguments
  • # id:
  • # field_name: Name of the Field to set
  • # choices: Choices of the Additional Info Field. Accepts a JSON
  • # array. The JSON array must beh encoded as a string
  • # locale: Country code in ISO 3166-1 alpha-2
  • updateField(id: Int!, field_name: String, choices: String, locale: String!): Field
  • # Given a position_id or a position_remote_id, first_name, last_name and email
  • # allows you to invite a person to apply for a Position. This will just send an
  • # email to the address specified and will not create an Application
  • #
  • # Arguments
  • # position_id: nCore Id of the Position. If the argument
  • # 'position_remote_id' is provided, this argument is not needed
  • # position_remote_id: Id set by you in nCore and used in your
  • # system. If the argument 'position_id' is provided, this argument is not needed
  • # first_name: First name of the person to invite to apply
  • # last_name: Last name of the person to invite to apply
  • # email: Email of the person to invite to apply
  • inviteToApply(
  • position_id: Int,
  • position_remote_id: String,
  • first_name: String!,
  • last_name: String!,
  • email: String!
  • ): InvitationToApply
  • # Given an id or remote_id of an Application allows you to send an email
  • # solicitation to complete the Application process
  • #
  • # Arguments
  • # id: nCore Id of the Application. If the arguments 'remote_id'
  • # and 'position_id' are provided, this argument is not needed
  • # remote_id: Id set by you in nCore and used in your system. If
  • # the argument 'id' is provided, this argument is ignored
  • # position_id: nCore Id of the Position to invite to complete. If
  • # the argument 'id' is provided, this argument is ignored
  • inviteToComplete(id: Int, remote_id: String, position_id: Int): Application
  • # Given an id or remote_id of an Application and a date allows you to create a
  • # Live Meeting
  • #
  • # Arguments
  • # id: nCore Id of the Application. If the arguments 'remote_id'
  • # and 'position_id' are provided, this argument is not needed
  • # remote_id: Id set by you in nCore and used in your system. If
  • # the argument 'id' is provided, this argument is ignored
  • # position_id: nCore Id of the Position to invite to complete. If
  • # the argument 'id' is provided, this argument is ignored
  • # date: Date of the Live Meeting. The format must be Y-m-d H:i:s
  • # timezone: Timezone of the Live Meeting. Must be in the format
  • # 'Europe/Paris' Here can find the supported timezone
  • # 'https://www.php.net/manual/en/timezones.php'. Default timezone set by the
  • # sender user in their profile.
  • # sender_id: The user ID of the sender
  • createLiveMeeting(
  • id: Int,
  • remote_id: String,
  • position_id: Int,
  • date: String!,
  • timezone: String,
  • sender_id: Int!
  • ): LiveInterview
  • # Given an Application id and a PipeLinePositionFolder id, move the Application
  • # into one PipeLinePositionFolder. It will execute any automatic operation
  • # associated (sending emails or asking for data) without warning.
  • #
  • # Arguments
  • # id:
  • # position_id:
  • # remote_id:
  • # pipe_line_position_folder_id:
  • moveApplicationToFolder(
  • id: Int,
  • position_id: Int,
  • remote_id: String,
  • pipe_line_position_folder_id: Int!
  • ): Application
  • # Given an Application id, remove the Application from the PipeLinePositionFolder
  • # that it is currently in.
  • #
  • # Arguments
  • # id:
  • # position_id:
  • # remote_id:
  • removeApplicationFromFolder(
  • id: Int,
  • position_id: Int,
  • remote_id: String
  • ): Application
  • }

link Require by

This element is not required by anyone