Jump to

• Request
• Response

Create an Assignment Favorite

post

/api/restapi/assignmentFavorite

Send a request to this endpoint to create an assignment 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 : ApiEntityAssignmentFavoriteInput

Type: object

Title: ApiEntityAssignmentFavoriteInput

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

• assignmentFavoriteId
• applicationUser,assignmentId
• activityCode,projectCode,workspaceCode,resourceCode,applicationUser
• activityCode,projectCode,workspaceCode,resourceCode,userName
• assignmentId,userName

Show Source

• activityCode: string
  Minimum Length: 0

  Maximum Length: 60

  The activity code of an assignment.
• applicationUser(required): integer (int64)
  The unique identifier of a user.
• assignmentFavoriteId: integer (int64)
  The unique identifier of an assignment favorite.
• assignmentId(required): integer (int64)
  The unique identifier for the assignment.The assignment object can also be identified by its unique criteria.
• 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 project code of an assignment.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class of the resource of an assignment.
• resourceCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified identifier of a resource.
• 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 workspace code of an assignment.

{
    "title":"ApiEntityAssignmentFavoriteInput",
    "required":[
        "applicationUser",
        "assignmentId"
    ],
    "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"
            ]
        },
        "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 activity code of an assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The project code of an assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The workspace code of an assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "applicationUser":{
            "type":"integer",
            "description":"The unique identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignmentId":{
            "type":"integer",
            "description":"The unique identifier for the assignment.The assignment object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified identifier of a resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class of the resource of an assignment. ",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "assignmentFavoriteId":{
            "type":"integer",
            "description":"The unique identifier of an assignment favorite.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "description":"This entity represents a AssignmentFavorite object, a unique AssignmentFavorite object can be identified by the following combinations of the fields.<ul><li>assignmentFavoriteId</li><li>applicationUser,assignmentId</li><li>activityCode,projectCode,workspaceCode,resourceCode,applicationUser</li><li>activityCode,projectCode,workspaceCode,resourceCode,userName</li><li>assignmentId,userName</li>",
    "exampleSetFlag":false
}

Examples

Select an example Create an Assignment Favorite

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityAssignmentFavorite

Type: object

Title: ApiEntityAssignmentFavorite

Show Source

• activityCode: string
  Minimum Length: 0

  Maximum Length: 60

  The activity code of an assignment.
• applicationUser: integer (int64)
  The unique identifier of a user.
• assignmentFavoriteId: integer (int64)
  The unique identifier of an assignment favorite.
• assignmentId: integer (int64)
  The unique identifier for the assignment.The assignment object can also be identified by its unique criteria.
• 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 project code of an assignment.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class of the resource of an assignment.
• resourceCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified identifier of a resource.
• 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 workspace code of an assignment.

{
    "title":"ApiEntityAssignmentFavorite",
    "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"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The activity code of an assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The project code of an assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The workspace code of an assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "applicationUser":{
            "type":"integer",
            "description":"The unique identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignmentId":{
            "type":"integer",
            "description":"The unique identifier for the assignment.The assignment object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified identifier of a resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class of the resource of an assignment. ",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "assignmentFavoriteId":{
            "type":"integer",
            "description":"The unique identifier of an assignment favorite.",
            "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 Assignment Favorite service.

Back to Top