Jump to

• Request
• Response

Create an Activity Favorite

post

/api/restapi/activityFavorite

Send a request to this endpoint to create an activity favorite. An application object will be created using the JSON data provided in the request body.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityActivityFavoriteInput

Type: object

Title: ApiEntityActivityFavoriteInput

This entity represents a ActivityFavorite object, a unique ActivityFavorite object can be identified by the following combinations of the fields.

• activityFavoriteId
• activity,applicationUser
• activityCode,projectCode,workspaceCode,applicationUser
• activity,userName
• activityCode,projectCode,workspaceCode,userName

Show Source

• activity(required): integer (int64)
  The unique identifier for the activity.The activity object can also be identified by its unique criteria.
• activityCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of the activity.
• activityFavoriteId: integer (int64)
  The unique identifier of an activity favorite.
• applicationUser(required): integer (int64)
  Unique identifier of a user.
• link: string (url)
  Read Only: true

  Deprecated. As of 24.5.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 24.5.
  Date when the record was last updated.
• userName: string
  Maximum Length: 255

  The username a user uses to log in to the system.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityActivityFavoriteInput",
    "required":[
        "activity",
        "applicationUser"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userName":{
            "maxLength":"255",
            "type":"string",
            "description":"The username a user uses to log in to the system.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityFavoriteId":{
            "type":"integer",
            "description":"The unique identifier of an activity favorite.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "applicationUser":{
            "type":"integer",
            "description":"Unique identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "activity":{
            "type":"integer",
            "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "description":"This entity represents a ActivityFavorite object, a unique ActivityFavorite object can be identified by the following combinations of the fields.<ul><li>activityFavoriteId</li><li>activity,applicationUser</li><li>activityCode,projectCode,workspaceCode,applicationUser</li><li>activity,userName</li><li>activityCode,projectCode,workspaceCode,userName</li>",
    "exampleSetFlag":false
}

Examples

Select an example Create an Activity_Favourate Using Codes Create an Activity Favorite

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityActivityFavorite

Type: object

Title: ApiEntityActivityFavorite

Show Source

• activity: integer (int64)
  The unique identifier for the activity.The activity object can also be identified by its unique criteria.
• activityCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of the activity.
• activityFavoriteId: integer (int64)
  The unique identifier of an activity favorite.
• applicationUser: integer (int64)
  Unique identifier of a user.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• updateDate: string (date-time)
  Date when the record was last updated.
• userName: string
  Maximum Length: 255

  The username a user uses to log in to the system.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityActivityFavorite",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userName":{
            "maxLength":"255",
            "type":"string",
            "description":"The username a user uses to log in to the system.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityFavoriteId":{
            "type":"integer",
            "description":"The unique identifier of an activity favorite.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "applicationUser":{
            "type":"integer",
            "description":"Unique identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "activity":{
            "type":"integer",
            "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Activity Favorite service.

Back to Top